Skip to main content

Database-driven way to put your Django site into maintenance mode.

Project description

Build Status

Current Version: 1.1.4

This project makes it easy to put your Django site into “maintenance mode”, or more technically, return an HTTP 503 response.

This project differs slightly from other implementations in that the maintenance mode flag is stored in your database versus settings or an environment variable. If your site is deployed to multiple servers, the centralized database-based maintenance flag makes it a snap to bring them all up or down at once.

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.
  • maintenancemode will ignore the default Django Admin login url: /admin/login/ so you can turn it off. If you use a custom url for admin, you may override the ignored login url by adding the MAINTENANCE_ADMIN_IGNORED_URLS list in settings. Example: ['^my-custom-admin/login/$']

Usage

Image of django-maintenancemode-2

Image of django-maintenancemode-2

Turning Maintenance Mode On

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

Turning Maintenance Mode Off

By default, maintenancemode will ignore the default Django Admin login url: /admin/login/ or optionally the list you specify via MAINTENANCE_ADMIN_IGNORED_URLS, which you must access directly in order to access Django Admin when maintenance mode is turned on, as redirects are disabled.

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.

Database migrations

Legacy support for South migrations is supported, otherwise manage.py syncdb should add the necessary tables.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-maintenancemode-2, version 1.1.4
Filename, size File type Python version Upload date Hashes
Filename, size django-maintenancemode-2-1.1.4.tar.gz (17.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page