From fbbda941102326ac91c2ebf2f67a269860290ad7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 19 Feb 2016 14:33:28 +0100 Subject: Fix #1351: add maintenance mode --- app/AppKernel.php | 1 + app/config/config.yml | 10 ++++++++++ composer.json | 3 ++- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/app/AppKernel.php b/app/AppKernel.php index 82d3aa38..08c9cc27 100644 --- a/app/AppKernel.php +++ b/app/AppKernel.php @@ -34,6 +34,7 @@ class AppKernel extends Kernel new Wallabag\ImportBundle\WallabagImportBundle(), new Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle(), new Craue\ConfigBundle\CraueConfigBundle(), + new Lexik\Bundle\MaintenanceBundle\LexikMaintenanceBundle(), ]; if (in_array($this->getEnvironment(), ['dev', 'test'], true)) { diff --git a/app/config/config.yml b/app/config/config.yml index bd269b07..07a4b0b6 100644 --- a/app/config/config.yml +++ b/app/config/config.yml @@ -200,3 +200,13 @@ scheb_two_factor: kphoen_rulerz: executors: doctrine: true + +lexik_maintenance: + authorized: + ips: ['127.0.0.1'] + driver: + ttl: 3600 + class: 'Lexik\Bundle\MaintenanceBundle\Drivers\DatabaseDriver' + response: + code: 503 + status: "wallabag Service Temporarily Unavailable" diff --git a/composer.json b/composer.json index c65ebda1..826eb91b 100644 --- a/composer.json +++ b/composer.json @@ -65,7 +65,8 @@ "doctrine/doctrine-migrations-bundle": "^1.0", "paragonie/random_compat": "~1.0", "craue/config-bundle": "~1.4", - "mnapoli/piwik-twig-extension": "^1.0" + "mnapoli/piwik-twig-extension": "^1.0", + "lexik/maintenance-bundle": "dev-master" }, "require-dev": { "doctrine/doctrine-fixtures-bundle": "~2.2", -- cgit v1.2.3 From 5bcf1afd91d6a22dd301fedc99384ad83a634695 Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Mon, 22 Feb 2016 10:16:02 +0100 Subject: Use a tag for lexik/maintenance-bundle --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 826eb91b..fe6880aa 100644 --- a/composer.json +++ b/composer.json @@ -66,7 +66,7 @@ "paragonie/random_compat": "~1.0", "craue/config-bundle": "~1.4", "mnapoli/piwik-twig-extension": "^1.0", - "lexik/maintenance-bundle": "dev-master" + "lexik/maintenance-bundle": "~2.1" }, "require-dev": { "doctrine/doctrine-fixtures-bundle": "~2.2", -- cgit v1.2.3 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 + 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 -- cgit v1.2.3