Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

django-maintenance-window

https://travis-ci.org/JostCrow/django-maintenance-window.svg?branch=master Lintly https://bettercodehub.com/edge/badge/JostCrow/django-maintenance-window?branch=master Maintainability

Your project description goes here

Documentation

The full documentation is at https://django-maintenance-window.readthedocs.io.

Quickstart

Install django-maintenance-window:

pip install django-maintenance-window

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django-solo',
    'django_maintenance_window',
    ...
)

Add django-maintenance-window's middleware to the middleware:

MIDDLEWARE_CLASSES = [
    ...
    'django_maintenance_window.middleware.MaintenanceModeMiddleware',
    ...
]

or

MIDDLEWARE = [
    ...
    'django_maintenance_window.middleware.MaintenanceModeMiddleware',
    ...
]

Settings

  • MAINTENANCE_TEMPLATE = 'django_maintenance_window/maintenance.html'
    Overwrite the template that is used for the maintenance template
  • MAINTENANCE_DISPLAY_END_DATE = False
    If the end date should be displayed at the bottom of the page.
  • MAINTENANCE_EXCLUDE_ADMIN_URLS = True
    This will allow accessing the admin even if maintenance mode is active.
  • MAINTENANCE_EXCLUDE_SUPER_USER = False
    This will allow super users to see the site even if maintenance mode is active.
  • MAINTENANCE_EXCLUDE_STAFF_USER = False
    This will allow staff users to see the site even if maintenance mode is active.

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package: