From 437f1985b090c026a130420213d608e1b13e141a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 22 Feb 2016 12:49:49 +0100 Subject: documentation for maintenance mode --- docs/en/developer/maintenance.rst | 32 ++++++++++++++++++++++++++++++++ docs/en/index.rst | 1 + 2 files changed, 33 insertions(+) create mode 100644 docs/en/developer/maintenance.rst (limited to 'docs/en') diff --git a/docs/en/developer/maintenance.rst b/docs/en/developer/maintenance.rst new file mode 100644 index 00000000..8277fb1f --- /dev/null +++ b/docs/en/developer/maintenance.rst @@ -0,0 +1,32 @@ +Maintenance mode +================ + +If you have some long tasks to do on your wallabag instance, you can enable a maintenance mode. +Nobody will have access to your instance. + +Enable maintenance mode +----------------------- + +To enable maintenance mode, execute this command: + +:: + + bin/console lexik:maintenance:lock --no-interaction + +You can set your IP address in ``app/config/config.yml`` if you want to access to wallabag even if maintenance mode is enabled. For example: + +:: + + lexik_maintenance: + authorized: + ips: ['127.0.0.1'] + + +Disable maintenance mode +------------------------ + +To disable maintenance mode, execute this command: + +:: + + bin/console lexik:maintenance:unlock diff --git a/docs/en/index.rst b/docs/en/index.rst index 17e375d2..1bac9ed7 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -41,3 +41,4 @@ The main documentation for this application is organized into a couple sections: developer/docker developer/translate + developer/maintenance -- cgit v1.2.3