artgris / maintenance-bundle
Symfony Bundle to place your Symfony website in maintenance mode
Installs: 70 666
Dependents: 0
Suggesters: 0
Security: 0
Stars: 23
Watchers: 3
Forks: 7
Open Issues: 0
Type:symfony-bundle
Requires
- php: >=8.0.2
- symfony/config: ^5.0|^6.0|^7.0
- twig/twig: ^2.12|^3.0
Requires (Dev)
- phpunit/phpunit: ~3.7
README
Symfony Bundle to place your Symfony website in maintenance mode - Default Maintenance Page
Installation
1) Download
composer require artgris/maintenance-bundle
2) Configure the Bundle
Adds following configurations
to config/packages/artgris_maintenance.yaml
:
artgris_maintenance: enable: true # Enable|Disable maintenance - default: false ips: ["127.0.0.1","::1",...] # IPs allow (prod) - default: [] response: 503 # Maintenance Page HTTP Status Code - default: 503
3) Override maintenance.html.twig (optional)
in templates/bundles/ArtgrisMaintenanceBundle/maintenance.html.twig
ex:
{% extends "@!ArtgrisMaintenance/maintenance.html.twig" %} {% block content %} <h1>Site en cours de maintenance</h1> <h2>Nous reviendrons bientôt. Désolé pour le dérangement.</h2> {% endblock %}
Usage
The dev
environment was not affected by maintenance.
- Enable|Disable maintenance :
enable: true|false
- Add authorized IPs to prod :
ips: ["127.0.0.1","::1",...]
- Maintenance Page HTTP Status Code :
response: 503
Don't forget to clear the prod
cache :
php bin/console cache:clear