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
How it works
maintenancemode works the same way as handling 404 or 500 error in
Django work. It adds a
handler503 which you can override in your
urls.py or you can add a
503.html to your templates
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
handler503variable in your ROOT_URLCONF, similar to how you would customize other error handlers, e.g. :
handler503 = 'example.views.maintenance_mode'
maintenancemodefrom GitHub, or install using pip :
pip install django-maintenancemode
INSTALLED_APPS = ( ... 'maintenancemode', )
MIDDLEWARE_CLASSES, make sure it comes after
MIDDLEWARE_CLASSES = ( ... 'django.contrib.auth.middleware.AuthenticationMiddleware', 'maintenancemode.middleware.MaintenanceModeMiddleware', )
Add variable called
MAINTENANCE_MODEin your project's
MAINTENANCE_MODE = True # Setting this variable to ``True`` activates the middleware.
python ./manage.py maintenance <on|off>
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
# Enable / disable maintenance mode. # Default: False MAINTENANCE_MODE = True # or ``False`` and use ``maintenance`` command # Sequence of URL path regexes to exclude from the maintenance mode. # Default: () MAINTENANCE_IGNORE_URLS = ( r'^/docs/.*', r'^/contact' )
django-maintenancemode is released under the BSD license.