django-maintenance-mode

Installation

Configuration (optional)

Settings

# if True the maintenance-mode will be activatedMAINTENANCE_MODE=None

# by default, to get/set the state value a local file backend is used# if you want to use the db or cache, you can create a custom backend# custom backends must extend 'maintenance_mode.backends.AbstractStateBackend' class# and implement get_value(self) and set_value(self, val) methodsMAINTENANCE_MODE_STATE_BACKEND="maintenance_mode.backends.LocalFileBackend"# alternatively it is possible to use the default storage backendMAINTENANCE_MODE_STATE_BACKEND="maintenance_mode.backends.DefaultStorageBackend"# alternatively it is possible to use the static storage backend# make sure that STATIC_ROOT and STATIC_URL are also setMAINTENANCE_MODE_STATE_BACKEND="maintenance_mode.backends.StaticStorageBackend"# alternatively it is possible to use the cache backend# you can use a custom cache backend by adding a `maintenance_mode` entry to `settings.CACHES`,# otherwise the default cache backend will be used.MAINTENANCE_MODE_STATE_BACKEND="maintenance_mode.backends.CacheBackend"

# the fallback value that backends will return in case of failure# (actually this is only used by "maintenance_mode.backends.CacheBackend")MAINTENANCE_MODE_STATE_BACKEND_FALLBACK_VALUE=False

# by default, a file named "maintenance_mode_state.txt" will be created in the settings.py directory# you can customize the state file path in case the default one is not writableMAINTENANCE_MODE_STATE_FILE_PATH="maintenance_mode_state.txt"

# if True admin site will not be affected by the maintenance-mode pageMAINTENANCE_MODE_IGNORE_ADMIN_SITE=False

# if True anonymous users will not see the maintenance-mode pageMAINTENANCE_MODE_IGNORE_ANONYMOUS_USER=False

# if True authenticated users will not see the maintenance-mode pageMAINTENANCE_MODE_IGNORE_AUTHENTICATED_USER=False

# if True the staff will not see the maintenance-mode pageMAINTENANCE_MODE_IGNORE_STAFF=False

# if True the superuser will not see the maintenance-mode pageMAINTENANCE_MODE_IGNORE_SUPERUSER=False

# list of ip-addresses that will not be affected by the maintenance-mode# ip-addresses will be used to compile regular expressions objectsMAINTENANCE_MODE_IGNORE_IP_ADDRESSES= ()

# the path of the function that will return the client IP address given the request object -> 'myapp.mymodule.myfunction'# the default function ('maintenance_mode.utils.get_client_ip_address') returns request.META['REMOTE_ADDR']# in some cases the default function returns None, to avoid this scenario just use 'django-ipware'MAINTENANCE_MODE_GET_CLIENT_IP_ADDRESS=None

MAINTENANCE_MODE_GET_CLIENT_IP_ADDRESS="ipware.ip.get_ip"

# the path of the function that will return the response context -> 'myapp.mymodule.myfunction'MAINTENANCE_MODE_GET_CONTEXT=None

# list of urls that will not be affected by the maintenance-mode# urls will be used to compile regular expressions objectsMAINTENANCE_MODE_IGNORE_URLS= ()

# if True the maintenance mode will not return 503 response while running tests# useful for running tests while maintenance mode is on, before opening the site to public useMAINTENANCE_MODE_IGNORE_TESTS=False

# if True authenticated users will be logged out from their current sessionMAINTENANCE_MODE_LOGOUT_AUTHENTICATED_USER=False

# the absolute url where users will be redirected to during maintenance-modeMAINTENANCE_MODE_REDIRECT_URL=None

# the type of the response returned during maintenance mode, can be either "html" or "json"MAINTENANCE_MODE_RESPONSE_TYPE="html"

# the template that will be shown by the maintenance-mode pageMAINTENANCE_MODE_TEMPLATE="503.html"

# the HTTP status code to sendMAINTENANCE_MODE_STATUS_CODE=503

# the value in seconds of the Retry-After header during maintenance-modeMAINTENANCE_MODE_RETRY_AFTER=3600# 1 hour

Context Processors

TEMPLATES= [    {# ..."OPTIONS": {"context_processors": [# ..."maintenance_mode.context_processors.maintenance_mode",# ...            ],        },# ...    },]

Logging

LOGGING= {"filters": {"require_not_maintenance_mode_503": {"()":"maintenance_mode.logging.RequireNotMaintenanceMode503",        },        ...    },"handlers": {        ...    },    ...}

Context Managers

frommaintenance_mode.coreimportmaintenance_mode_off,maintenance_mode_onwithmaintenance_mode_on():# do stuffpasswithmaintenance_mode_off():# do stuffpass

URLs

urlpatterns= [# ...re_path(r"^maintenance-mode/",include("maintenance_mode.urls")),# ...]

Views

Function-based views

frommaintenance_mode.decoratorsimportforce_maintenance_mode_off,force_maintenance_mode_on@force_maintenance_mode_offdefmy_view_a(request):# never return 503 responsepass@force_maintenance_mode_ondefmy_view_b(request):# always return 503 responsepass

Class-based views

frommaintenance_mode.decoratorsimportforce_maintenance_mode_off,force_maintenance_mode_onurlpatterns= [# never return 503 responsepath("",force_maintenance_mode_off(YourView.as_view()),name="my_view"),# always return 503 responsepath("",force_maintenance_mode_on(YourView.as_view()),name="my_view"),]

Usage

Python

frommaintenance_mode.coreimportget_maintenance_mode,set_maintenance_modeset_maintenance_mode(True)ifget_maintenance_mode():set_maintenance_mode(False)

fromdjango.core.managementimportcall_commandfromdjango.core.management.baseimportBaseCommandclassCommand(BaseCommand):defhandle(self,*args,**options):call_command("maintenance_mode","on")# call your command(s)call_command("maintenance_mode","off")

Templates

{% if maintenance_mode %}<!-- html -->{% endif %}

Terminal

URLs

Testing

# clone repositorygit clone https://github.com/fabiocaccamo/django-maintenance-mode.git&&cd django-maintenance-mode# create virtualenv and activate itpython -m venv venv&&. venv/bin/activate# upgrade pippython -m pip install --upgrade pip# install requirementspip install -r requirements.txt -r requirements-test.txt# install pre-commit to run formatters and linterspre-commit install --install-hooks# run teststox# orpython runtests.py# orpython -m djangotest --settings"tests.settings"

License

Supporting

See also