documentation for maintenance mode

1 files changed, 32 insertions, 0 deletions

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