Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A friendly fork of django-maintenancemode
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
maintenancemode Whops!
testproject Added ability to exclude specific paths from maintenance mode with th…
.gitignore Added the request context and the request_path variable to the template.
AUTHORS Updated project to use django 1.0.X release branch and use buildout
CHANGES Added news for last commits.
LICENSE Added setup file + basic project documentation
MANIFEST.in A few updates for packaging non-Python files.
README.rst A few updates for packaging non-Python files.
bootstrap.py Updated buildout bootstrapper and config file.
buildout.cfg Updated buildout bootstrapper and config file.
setup.py

README.rst

django-maintenancemode

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.

Installation

  • Download django-maintenancemode from http://pypi.python.org/pypi/django-maintenancemode or http://code.google.com/p/django-maintenancemode/

  • Install using: python setup.py install

  • In your Django settings file add maintenancemode to your MIDDLEWARE_CLASSES. Make sure it comes after Django's AuthenticationMiddleware. Like so:

    MIDDLEWARE_CLASSES = (
        'django.middleware.common.CommonMiddleware',
        'django.contrib.sessions.middleware.SessionMiddleware',
        'django.contrib.auth.middleware.AuthenticationMiddleware',
        'django.middleware.doc.XViewMiddleware',
    
        'maintenancemode.middleware.MaintenanceModeMiddleware',
    )
    
  • django-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.

  • In your Django settings file add a variable called MAINTENANCE_MODE. Setting this variable to True activates the middleware.

Configuration

If you do not configure the settings below in your own project settings.py, they assume default values:

MAINTENANCE_MODE

Default: False

Boolean. Enable/disable maintenance mode.

MAINTENANCE_IGNORE_URLS

Default: ()

Sequence of URL path regexes to exclude from the maintenance mode.

Example:

MAINTENANCE_IGNORE_URLS = (
    r'^/docs/.*',
    r'^/contact'
)

Some observations:

  • 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.
Something went wrong with that request. Please try again.