django-maintenancemode is a middleware that allows you to temporary shutdown your site for maintenance work.
Logged in users having staff credentials can still fully use the site as can users visiting the site from an IP address defined in Django's INTERNAL_IPS
.
Authored by Remco Wendt, and some great contributors.
maintenancemode
works the same way as handling 404 or 500 error in Django work. It adds a handler503
which you can override in your main urls.py
or you can add a 503.html
to your templates directory.
- If user is logged in and staff member, the maintenance page is not displayed.
- If user's IP is in
INTERNAL_IPS
, the maintenance page is not displayed. To override the default view which is used if the maintenance mode is enabled you can simply define a
handler503
variable in your ROOT_URLCONF, similar to how you would customize other error handlers, e.g. :
Either checkout
maintenancemode
from GitHub, or install using pip :Add
maintenancemode
to yourINSTALLED_APPS
:Add
MaintenanceModeMiddleware
toMIDDLEWARE_CLASSES
, make sure it comes afterAuthenticationMiddleware
:Add variable called
MAINTENANCE_MODE
in your project'ssettings.py
file :or set
MAINTENANCE_MODE
toFalse
and usemaintenance
command :python ./manage.py maintenance <on|off>
Please see example
application. This application is used to manually test the functionalities of this package. This also serves as a good example...
You need only Django 1.4 or above to run that. It might run on older versions but that is not tested.
There are various optional configuration options you can set in your settings.py
django-maintenancemode
is released under the BSD license.