aboutsummaryrefslogtreecommitdiff
path: root/doc/administration/maintenance-mode.rst
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2024-04-05 22:34:08 +0200
committerDaniel Schadt <kingdread@gmx.de>2024-04-05 22:34:45 +0200
commit4f96b9c3f39213a5f6ae631c7c820f63fc2219d5 (patch)
tree002a30ecabab225d77e3df0e89fdb3584a04cc6b /doc/administration/maintenance-mode.rst
parent6ee21f6c078891e4453415cbebd6b7d591185c5f (diff)
downloadfietsboek-4f96b9c3f39213a5f6ae631c7c820f63fc2219d5.tar.gz
fietsboek-4f96b9c3f39213a5f6ae631c7c820f63fc2219d5.tar.bz2
fietsboek-4f96b9c3f39213a5f6ae631c7c820f63fc2219d5.zip
documentation improvements
Diffstat (limited to 'doc/administration/maintenance-mode.rst')
-rw-r--r--doc/administration/maintenance-mode.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/administration/maintenance-mode.rst b/doc/administration/maintenance-mode.rst
index d02e27a..30a273c 100644
--- a/doc/administration/maintenance-mode.rst
+++ b/doc/administration/maintenance-mode.rst
@@ -7,7 +7,7 @@ with the data. Deactivating your instance avoids any "race issues" or accesses
to the database and such, which might be in inconsistent states.
To help with this situation, fietsboek provides a *maintenance mode*. This
-allows you to deactivate fietsboek without having to fiddle with your webserver
+allows you to deactivate fietsboek without having to change with your webserver
settings.
In the maintenance mode, fietsboek will reply to any HTTP request with a ``503
@@ -16,8 +16,8 @@ Service Unavailable`` response, and won't process the requests further.
.. note::
The maintenance mode is implemented early in fietsboek, however if you have
- custom HTTP proxies or other WSGI middleware between fietsboek and the
- outside world, the maintenance mode will not affect those.
+ custom HTTP proxies, caches or other WSGI middleware between fietsboek and
+ the outside world, the maintenance mode will not affect those.
In those cases, it might be better to deactivate the whole pipeline,
depending on the setup and the middleware used — at least if those also
@@ -25,17 +25,17 @@ Service Unavailable`` response, and won't process the requests further.
In addition to not replying to HTTP requests, ``fietscron`` will also respect
the maintenance mode and do nothing. This is to avoid accidental interference
-with long tasks like updating, such that a cronjob doesn't access data in an
-invalid state.
+with long tasks like updating, such that a badly-timed cronjob doesn't access
+data in an invalid state.
-Unlike ``fietscron`` and the HTTP requests, ``fietsctl`` and ``fietsupdate``
+Unlike ``fietscron`` and the web interface, ``fietsctl`` and ``fietsupdate``
will **continue to work**.
Controlling the Maintenance Mode
--------------------------------
You can enable and disable the maintenance mode using the ``fietsctl`` script.
-To enable the mode, simply pass a reason (that will be shown to users) to
+To enable maintenance, simply pass a reason (that will be shown to users) to
``fietsctl maintenance-mode``::
fietsctl -c production.ini maintenance-mode "Updating the instance"