Maintenance Mode
Customizable maintenance mode
Maintenance Mode
Customizable maintenance mode
Install
composer require nearata/flarum-ext-maintenance-mode:"*"
Update
composer update nearata/flarum-ext-maintenance-mode:"*"
php flarum cache:clear
Remove
composer remove nearata/flarum-ext-maintenance-mode
php flarum cache:clear
How to use
Switch the Maintenance Mode
in the extension settings page.
With a command
php flarum nearataMaintenanceMode:toggle <true or false>
With API endpoint
PATCH /api/nearata/maintenanceMode/enabled
{
"value": true or false
}
if the body is empty, it will be evaluated as false.
An empty response is returned either way.
How to style
To change the style of the page, there's no other way but to override the file itself.
Follow the below link to see a how-to:
https://docs.flarum.org/extend/views/#overriding-views
How to bypass maintenance
If you have permissions to bypass the maintenance mode, you can run the below command to generate a link to login in a authorized user.
Assure you are in the Flarum root folder
:
php flarum nearataMaintenanceMode:auth <user_id>
Note
- If the database is inaccessible, this situation is not handled.
Features
© 2023 Hyn by DaniĆ«l "Luceos" Klabbers. All rights reserved. · Extensions and extension information is provided by the respective (copyright holding) authors. · Extiverse is not affiliated to the Flarum project or Flarum foundation. · Images on Extiverse pages are from Unsplash.