django-maintenancemode 0.11.7

工作原理

maintenancemode与Django中处理404或500错误的方式相同。它添加了一个可重写的handler503，你可以在你的主urls.py中覆盖它，或者你可以在你的模板目录中添加一个503.html。

• 如果用户已登录并且是工作人员，则不会显示维护页面。

• 如果用户的IP在INTERNAL_IPS中，则不会显示维护页面。

• 要覆盖默认视图（当启用维护模式时使用），你可以在你的ROOT_URLCONF中定义一个handler503变量，类似于定制其他错误处理程序的方式，例如：

  handler503 = 'example.views.maintenance_mode'

安装

1. 要么从GitHub检出maintenancemode，要么使用pip安装。

   pip install django-maintenancemode

2. 将maintenancemode添加到你的INSTALLED_APPS。

   INSTALLED_APPS = (
       ...
       'maintenancemode',
   )

3. 将MaintenanceModeMiddleware添加到MIDDLEWARE_CLASSES，确保它在AuthenticationMiddleware之后。

   MIDDLEWARE_CLASSES = (
       ...
       'django.contrib.auth.middleware.AuthenticationMiddleware',
       'maintenancemode.middleware.MaintenanceModeMiddleware',
   )

4. 在你的项目的settings.py文件中添加一个名为MAINTENANCE_MODE的变量。

   MAINTENANCE_MODE = True  # Setting this variable to ``True`` activates the middleware.

   或将MAINTENANCE_MODE设置为False并使用maintenance命令。

   python ./manage.py maintenance <on|off>

请参阅示例应用程序。此应用程序用于手动测试此包的功能。这也可以作为一个很好的例子...

你需要Django 1.4或更高版本来运行它。它可能在旧版本上运行，但尚未进行测试。

配置

你可以在你的settings.py中设置各种可选配置选项。

# Enable / disable maintenance mode.
# Default: False
MAINTENANCE_MODE = True  # or ``False`` and use ``maintenance`` command

# Sequence of URL path regexes to exclude from the maintenance mode.
# Default: ()
MAINTENANCE_IGNORE_URLS = (
    r'^/docs/.*',
    r'^/contact'
)

许可协议

django-maintenancemode在BSD许可证下发布。