From 437f1985b090c026a130420213d608e1b13e141a Mon Sep 17 00:00:00 2001 From: =?utf8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 22 Feb 2016 12:49:49 +0100 Subject: [PATCH] documentation for maintenance mode --- docs/en/developer/maintenance.rst | 32 ++++++++++++++++++++++++++++++ docs/en/index.rst | 1 + docs/fr/developer/maintenance.rst | 33 +++++++++++++++++++++++++++++++ docs/fr/index.rst | 1 + 4 files changed, 67 insertions(+) create mode 100644 docs/en/developer/maintenance.rst create mode 100644 docs/fr/developer/maintenance.rst 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 diff --git a/docs/fr/developer/maintenance.rst b/docs/fr/developer/maintenance.rst new file mode 100644 index 00000000..4ea8d01f --- /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 a47b8a62..af5ed14f 100644 --- 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 -- 2.41.0