documentation for maintenance mode

diff --git a/docs/en/developer/maintenance.rst b/docs/en/developer/maintenance.rst
new file mode 100644 (file)
index 0000000..8277fb1
--- /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 17e375d2db71eef98eb45e7dad6a80699ee1984d..1bac9ed77ff307196072cc438acc6636a0a6e018 100644 (file)
--- 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

diff --git a/docs/fr/developer/maintenance.rst b/docs/fr/developer/maintenance.rst
new file mode 100644 (file)
index 0000000..4ea8d01
--- /dev/null
+++ b/docs/fr/developer/maintenance.rst
@@ -0,0 +1,33 @@
+Mode maintenance
+================
+
+Si vous devez effectuer de longues tâches sur votre instance de wallabag, vous pouvez activer le mode maintenance.
+Plus personne ne pourra accéder à wallabag.
+
+Activer le mode maintenance
+---------------------------
+
+Pour activer le mode maintenance, exécutez cette commande :
+
+::
+
+    bin/console lexik:maintenance:lock --no-interaction
+
+Vous pouvez spécifier votre adresse IP dans ``app/config/config.yml`` si vous souhaitez accéder à wallabag même si
+ le mode maintenance est activé. Par exemple :
+
+::
+
+    lexik_maintenance:
+        authorized:
+            ips: ['127.0.0.1']
+
+
+Désactiver le mode maintenance
+------------------------------
+
+Pour désactiver le mode maintenance, exécutez cette commande :
+
+::
+
+    bin/console lexik:maintenance:unlock

diff --git a/docs/fr/index.rst b/docs/fr/index.rst
index a47b8a62399f13701b9f0307fa3cd057224c367a..af5ed14f2c86a0073c69ac7eb333a8a3ccb324f8 100644 (file)
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -42,3 +42,4 @@ La documentation principale de cette application est découpée en plusieurs sec
 
    developer/docker
    developer/translate
+   developer/maintenance