https://github.com/figuren-theater/ft-maintenance
Everything you need to maintain and maybe debug a running WordPress multisite network like figuren.theater
https://github.com/figuren-theater/ft-maintenance
backups cron debug error-log wordpress wordpress-muplugin
Last synced: 4 months ago
JSON representation
Everything you need to maintain and maybe debug a running WordPress multisite network like figuren.theater
- Host: GitHub
- URL: https://github.com/figuren-theater/ft-maintenance
- Owner: figuren-theater
- License: gpl-3.0
- Created: 2022-11-12T21:42:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T00:32:27.000Z (over 1 year ago)
- Last Synced: 2024-12-30T12:03:19.774Z (over 1 year ago)
- Topics: backups, cron, debug, error-log, wordpress, wordpress-muplugin
- Language: PHP
- Homepage: https://websites.fuer.figuren.theater
- Size: 272 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
figuren.theater | Maintenance
Everything you need to maintain and maybe debug a running WordPress Multisite network for puppeteers like figuren.theater.
Read our blog
See the network in action
•
Join the network
•
Create your own network
## About
This is the long desc
* [x] *list closed tracking-issues or `docs` files here*
* [ ] Do you have any [ideas](https://github.com/figuren-theater/ft-maintenance/issues/new) ?
## Background & Motivation
...
## Install
1. Add this *extra* to your `composer.json`
```json
"extra": {
"dropin-paths": {
"htdocs/wp-content/": [
"package:figuren-theater/ft-maintenance:templates/htdocs/wp-content/db-error.php",
"package:figuren-theater/ft-maintenance:templates/htdocs/wp-content/maintenance.php",
"package:figuren-theater/ft-maintenance:templates/htdocs/wp-content/php-error.php"
]
}
}
```
2. Install via command line
```sh
composer require figuren-theater/ft-maintenance
```
## Usage
### API
```php
Figuren_Theater::API\get_...()
```
### Plugins included
This package contains the following plugins.
Thoose are completely managed by code and lack of their typical UI.
* [Multisite Enhancements](https://wordpress.org/plugins/multisite-enhancements/#developers)
* [Query Monitor](https://wordpress.org/plugins/query-monitor/#developers)
* [WP Crontrol](https://wordpress.org/plugins/wp-crontrol/#developers)
* [WP Cron Runner](https://github.com/devgeniem/wp-cron-runner)
A simple mu-plugin to run cron jobs on WordPress installations
* [Database Backup for WordPress](https://wordpress.org/plugins/wp-db-backup/#developers)
* [WP Sync DB](https://github.com/hrsetyono/wp-sync-db)
### What does this package do in addition?
Accompaniying the core functionality of the mentioned plugins, theese **best practices** are included with this package.
- Show a Dashboard Widget with the content of either the Error- or the Debug-logfile to Users with `manage-sites` capabilities.
- manual maintenance mode, just define `FT_MAINTENANCE_MODE` somewhere, before the `init` action is called
- Delete some additional DB tables, created by plugins, during blog-deletion.
- Prevent WordPress from doing *cronjobs* during user-interaction, but instead call the built-in cronjob-mechanism for all sites at once and on a regularly basis using a Github Action.
## Built with & uses
- [dependabot](/.github/dependabot.yml)
- [code-quality](https://github.com/figuren-theater/code-quality/)
A set of status checks to ensure high and consitent code-quality for the figuren.theater platform.
- ....
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Versioning
We use [Semantic Versioning](http://semver.org/) for versioning. For the versions
available, see the [tags on this repository](https://github.com/figuren-theater/ft-maintenance/tags).
## Authors
- **Carsten Bach** - *Provided idea & code* - [figuren.theater/crew](https://figuren.theater/crew/)
See also the list of [contributors](https://github.com/figuren-theater/ft-maintenance/contributors)
who participated in this project.
## License
This project is licensed under the **GPL-3.0-or-later**, see the [LICENSE](/LICENSE) file for
details
## Acknowledgments
- [Alexandros Kozák](https://github.com/agkozak) for his smart error handler
- [altis](https://github.com/search?q=org%3Ahumanmade+altis) by humanmade, as our digital role model and inspiration
- [@roborourke](https://github.com/roborourke) for his clear & understandable [coding guidelines](https://docs.altis-dxp.com/guides/code-review/standards/)
- [python-project-template](https://github.com/rochacbruno/python-project-template) for their nice template->repo renaming workflow