figuren-theater/ft-maintenance

Everything you need to maintain and maybe debug a running WordPress Multisite network like figuren.theater

1.4.0 2024-10-25 16:40 UTC

Requires

• php: >=7.1
• devgeniem/wp-cron-runner: 1.0.3
• figuren-theater/ft-options: *
• johnbillion/query-monitor: 3.16.4
• johnbillion/wp-crontrol: 1.17.0
• koodimonni/composer-dropin-installer: 1.4
• pixelstudio/wp-sync-db: 1.7.1
• wpackagist-plugin/multisite-enhancements: 1.7.1
• wpackagist-plugin/wp-db-backup: 2.5.2

Requires (Dev)

• figuren-theater/code-quality: *

Suggests

• figuren-theater/ft-routes: Contains the mandatory filter, which will remove REST API enpoints from public.

GPL-3.0-or-later

• figuren.theater
• Carsten Bach

• debug
• wordpress
• cron
• maintenance
• error_log
• backups

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

• list closed tracking-issues or docs files here
• Do you have any ideas ?

Background & Motivation

...

Install

1. Add this extra to your composer.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

   composer require figuren-theater/ft-maintenance

Usage

API

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
• Query Monitor
• WP Crontrol
• WP Cron Runner A simple mu-plugin to run cron jobs on WordPress installations
• Database Backup for WordPress
• 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
• 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 for versioning. For the versions available, see the tags on this repository.

Authors

• Carsten Bach - Provided idea & code - figuren.theater/crew

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL-3.0-or-later, see the LICENSE file for details

Acknowledgments

• Alexandros Kozák for his smart error handler
• altis by humanmade, as our digital role model and inspiration
• @roborourke for his clear & understandable coding guidelines
• python-project-template for their nice template->repo renaming workflow