django-maintenancemode-2 1.1.3

Requirements

• django

• django.contrib.sites

Pre-Requisites

You must have at least one Site entry in your database before installing django-maintenancemode-2.

Supported Django Versions

• 1.9

• 1.8

• 1.7

• 1.6

• 1.5 or below should work, but come on, it’s time to upgrade :)

Installation

1. pip install django-maintenancemode-2

– or –

1. Download django-maintenancemode-2 from source

2. *optional: Enable a virtualenv

3. Run python setup.py install or add maintenancemode to your PYTHONPATH

Settings and Required Values

• Ensure the Sites Framework is enabled and that you have at least one entry in the Sites table.

• Add maintenancemode.middleware.MaintenanceModeMiddleware to your MIDDLEWARE_CLASSES

• Add maintenancemode to your INSTALLED_APPS

• Run python manage.py syncdb to create the maintenancemode tables.

• Run your project to automatically add the maintenancemode database records.

• Add a 503.html template to the root of your templates directory, or optionally add a MAINTENANCE_503_TEMPLATE path to your 503.html file’s location in settings.

Usage

To put a site into “Maintenance Mode”, just check the “In Maintenance Mode” checkbox and save in Django Admin under the “Maintenancemode” section. The next time you visit the public side of the site it will return a 503 if:

• You are not a superuser / staff

• You are not viewing a URL in the ignored patterns list

• Your REMOTE_ADDR does not appear in the INTERNAL_IPS setting

Maintenance mode will create a database record per site in the Sites app. This allows you to bring each domain down independently if your project serves multiple domains.

Patterns to ignore are registered as an inline model for each maintenance record. Patterns are defined exactly the same way you write Django URLs normally.

Testing and Sample Application

A “testproject” application is included which also contains unit and functional tests you can run via python manage.py test from the testproject directory.

The admin username/password is: admin

There are only two views in the testproject: - / - ignored-page

To see maintenancemode in action, log into Django admin, and set the maintenance mode to true. Log out, then visit the home page and instead, you’ll be greeted with the maintenance page.

To have maintenancemode ignore the “ignnored-page” view, simply add it’s url pattern to the Ignored URLs as:

/ignored-page

Now you should be able to visit the /ignored-page view regardless of the maintenancemode status. This is useful for contact or help pages that you still want people to be able to access while you’re working on other parts of the site.