Download the PHP package moritzebeling/kirby-maintenance without Composer
On this page you can find all versions of the php package moritzebeling/kirby-maintenance. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download moritzebeling/kirby-maintenance
More information about moritzebeling/kirby-maintenance
Files in moritzebeling/kirby-maintenance
Package kirby-maintenance
Short Description Kirby Maintenance mode plugin
License MIT
Homepage https://github.com/moritzebeling/kirby-meintenance
Informations about the package kirby-maintenance
Kirby Maintenance Mode Plugin
This plugin uses the route:before
hook to hide the whole website from not-logged-in users when option('maintenance')
is set to true
. It also sends a 503
code.
Kirby urls like assets
, api
, media
, panel
will be ignored and are still available.
Installation
Or download/clone this repo into site/plugins
of your Kirby project.
There are different ways to control the maintenance mode:
Via option
Via panel
Add a field maintenance
to the site.yml
blueprint to meet the condition $site->maintenance()->isTrue()
.
Via $site->maintenance_text()
you could edit the text that would welcome any logged out website visitor.
You can also use one of the prefabricated blueprint parts:
tabs/maintenance
sections/maintenance
fields/maintenance
fields/maintenance_text
Via file
You could also add a /.maintenance
file to the Kirby root directory to switch on maintenance mode. This method is used by bnomei/kirby3-janitor plugin. If you enter any text inside that file, this will be the output when the site is in maintenance mode.
Suggested by https://github.com/moritzebeling/kirby-maintenance/issues/1
Add style
With the moritzebeling.kirby-maintenance.css
option you could add a stylesheet, e.g.:
Development
- Install a fresh Kirby StarterKit
cd site/plugins
git clone
this repo
Roadmap
- [ ] Check if there is a page with the slug
maintenance
, if yes, display that page - [ ] Allow pages to be ignored via field or blueprint option
- [ ] Multilang support
☕️ Support
If you like this plugin, I would be glad if you would invite for on a coffee via PayPal If you have any ideas for further development or stumble upon any problems, please open an issue or PR. Thank you!
Warranty
This plugin is work in progress and comes without any warranty. Use at your own risk.