summaryrefslogtreecommitdiff
path: root/doc/source/config.rst
diff options
context:
space:
mode:
authorxXx-caillou-xXx2018-08-30 15:02:22 +0200
committerjvoisin2018-08-30 13:02:22 +0000
commitb3f67a16094168cc334f5da93a86f09476e01601 (patch)
treede533b00c850ba1b64173a1d777f366a12f098df /doc/source/config.rst
parentf61a4772bfc33e08e7b06250e2f0f640bcae875f (diff)
Change how we're handling invalid configurations
Since our configuration format is a bit more complex than php's one, we have a `sp.allow_broken_configuration` parameter (`false` by default), that you can set to `true` if you want PHP to carry on if your Snuffleupagus' configuration contains syntax errors. You'll still get a big scary message in your logs of course. We do **not** recommend to use it of course, but sometimes it might be useful to be able to "debug in production" without breaking your website.
Diffstat (limited to 'doc/source/config.rst')
-rw-r--r--doc/source/config.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/source/config.rst b/doc/source/config.rst
index e209ecb..8fd9097 100644
--- a/doc/source/config.rst
+++ b/doc/source/config.rst
@@ -50,6 +50,14 @@ To sum up, you should put this in your ``php.ini``:
50 50
51And the **snuffleupagus rules** into the ``.rules`` files. 51And the **snuffleupagus rules** into the ``.rules`` files.
52 52
53Since our configuration format is a bit more complex than php's one,
54we have a ``sp.allow_broken_configuration`` parameter (``false`` by default),
55that you can set to ``true`` if you want PHP to carry on if your Snuffleupagus'
56configuration contains syntax errors. You'll still get a big scary message in
57your logs of course. We do **not** recommend to use it of course, but sometimes
58it might be useful to be able to "debug in production" without breaking your
59website.
60
53Miscellaneous 61Miscellaneous
54------------- 62-------------
55 63
@@ -70,6 +78,7 @@ This configuration variable contains parameters that are used by multiple featur
70- ``cookie_env_var``: A environment variable used as part of cookies encryption. 78- ``cookie_env_var``: A environment variable used as part of cookies encryption.
71 See the :ref:`relevant documentation <config_cookie-encryption>` 79 See the :ref:`relevant documentation <config_cookie-encryption>`
72 80
81
73Bugclass-killer features 82Bugclass-killer features
74------------------------ 83------------------------
75 84