Guide
Maintenance mode: keep everyone out while you work
Show a maintenance page to everyone but administrators while you move, import or rebuild, and turn it off again from the browser, SSH or FTP.
This is part of Qorekit 0.3, out now as a beta: download 0.3.0-beta.1. As with any beta, keep a backup of anything you cannot afford to lose.
Some work is easier when nobody else is using Qorekit. You might be moving it to another server, running a large import or changing many entities at once. Maintenance mode shows everyone else a page that says Qorekit is in maintenance, while administrators go on working.
Turning it on
Open Administration › System and go to Maintenance mode. Fill in what you need, then choose Turn on.
- Message is what the maintenance page says. Left empty, it says Qorekit is in maintenance and to try again a little later.
- Back by is optional. It is shown on the page, and it tells programs that call the API when to try again.
- Roles that may still work lets some people go on working, such as the ones who check your changes. Administrators always may.
- Hold scheduled work makes imports, emails and other scheduled work wait until maintenance ends.
From then on, people outside those roles see the maintenance page and cannot sign in. Administrators see a strip at the top of every page, so they do not forget that it is on.
While it is on
You can change the message, the time or the roles at any moment. Change them in the same section and choose Save changes.
Programs that use the API get an answer that says Qorekit is in maintenance. With Back by filled in, the answer also says when to try again.
Turning it off
Choose Turn off in the same section. People who were shut out get back in with their next page. Scheduled work you held runs again.
Updates use it by themselves
When you install an update, Qorekit turns maintenance mode on while it replaces its files, and off again when it is done. Others see a page saying Qorekit is being updated. If maintenance mode was already on before the update, it stays on as you set it. See how signed updates work.
From the command line
With SSH, php artisan qorekit:maintenance does the same as the section in the browser:
php artisan qorekit:maintenance on --message="Moving to a new server." --until="2026-12-01 18:00"
php artisan qorekit:maintenance on --roles=testers,editors --pause-work
php artisan qorekit:maintenance status
php artisan qorekit:maintenance off
--until is in UTC, and --roles takes role keys.
When nobody can get in
If everyone sees “In maintenance”, an administrator turned it on or an update stopped halfway. Administrators can still sign in and turn it off.
If nobody can, use the file. Maintenance mode is kept in storage/framework/qorekit-maintenance.json. Deleting it over FTP, or in your hosting panel’s file manager, turns maintenance mode off.
Maintenance mode is described in the documentation, with the command in the command line reference.