Maintenance addon for Statamic inspired by plugrbase/statamic-maintenance-mode
This addon allows you to put your site into maintenance mode. When maintenance mode is enabled, your site will display a maintenance page to all visitors except Control Panel users (super users or users with the access cp permission).
You can customize the maintenance page or use the default one.
Features
- Simple and quick setup
- Fully customizable to suit your needs
- Integrated Bard field for rich text formatting
- Supports dark mode for a sleek appearance
Compatibility
- Statamic 6.x
Installation
You can install this addon via Composer:
composer require samosadlaker/statamic-maintenanceControl Panel
The settings page is rendered with Statamic 6's built-in publish form, so the addon
ships no Control Panel assets and requires no npm build step.
Use the Use default maintenance page toggle to switch between the addon's built-in page and a custom template. When it is disabled, a Custom Maintenance Page field appears and lets you pick one of your application's templates.
Configuration
The addon stores its settings in content/maintenance.yaml and registers:
- CP settings page:
cp/maintenance - Frontend maintenance page:
/maintenance
Bypass behavior during maintenance mode:
- Super users
- Users with the
access cppermission
Production Notes
- Keep
content/maintenance.yamlwritable by your deployment/runtime user. - If you customize the maintenance view, publish the views:
php artisan vendor:publish --tag=statamic-maintenance-views- Clear and refresh Statamic content caches after deployment when needed:
php artisan statamic:stache:clearphp artisan statamic:stache:warmLocal Testing
Run tests locally:
vendor/bin/phpunit -c phpunit.xmlShowcase
In the control panel, you can set a custom Title, Message, and Maintenance Page. Toggle Use default maintenance page to use the addon's built-in page, or pick a custom template.
License
The MIT License (MIT). Please see License File for more information.
