summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/config.rst36
1 files changed, 23 insertions, 13 deletions
diff --git a/doc/source/config.rst b/doc/source/config.rst
index a022ddb..d8389b6 100644
--- a/doc/source/config.rst
+++ b/doc/source/config.rst
@@ -1,19 +1,6 @@
1Configuration 1Configuration
2============= 2=============
3 3
4Since PHP *ini-like* configuration model isn't flexible enough,
5Snuffleupagus is using its own format in the file specified by
6the directive ``sp.configuration_file`` (in your ``php.ini`` file),
7like ``sp.configuration_file=/etc/php/conf.d/snuffleupagus.rules``.
8
9You can use the ``,`` separator to include multiple configuration files:
10``sp.configuration_file=/etc/php/conf.d/snuffleupagus.rules,/etc/php/conf.d/sp_wordpress.rules``.
11
12We're also also supporting `glob <https://en.wikipedia.org/wiki/Glob_%28programming%29>`__,
13so you can write something like:
14``sp.configuration_file=/etc/php/conf.d/*.rules,/etc/php/conf.d/extra/test.rules``.
15
16
17Options are chainable by using dots (``.``) and string parameters 4Options are chainable by using dots (``.``) and string parameters
18**must** be quoted, while booleans and integers aren't. 5**must** be quoted, while booleans and integers aren't.
19 6
@@ -39,6 +26,29 @@ but will write a warning in the log.
39The rules are evaluated in the order that they are written, the **first** one 26The rules are evaluated in the order that they are written, the **first** one
40to match will terminate the evaluation (except for rules in simulation mode). 27to match will terminate the evaluation (except for rules in simulation mode).
41 28
29Configuration file format
30-------------------------
31
32Since PHP *ini-like* configuration model isn't flexible enough,
33Snuffleupagus is using its own format in the file specified by
34the directive ``sp.configuration_file`` **in** your ``php.ini`` file,
35like ``sp.configuration_file=/etc/php/conf.d/snuffleupagus.rules``.
36
37You can use the ``,`` separator to include multiple configuration files:
38``sp.configuration_file=/etc/php/conf.d/snuffleupagus.rules,/etc/php/conf.d/sp_wordpress.rules``.
39
40We're also also supporting `glob <https://en.wikipedia.org/wiki/Glob_%28programming%29>`__,
41so you can write something like:
42``sp.configuration_file=/etc/php/conf.d/*.rules,/etc/php/conf.d/extra/test.rules``.
43
44To sum up, you should put this in your ``php.ini``:
45
46::
47
48 module=snuffleupagus.so
49 sp.configuration_file=/path/to/your/snufflepagus/rules/file.rules
50
51And the **snuffleupagus rules** into the ``.rules`` files.
42 52
43Miscellaneous 53Miscellaneous
44------------- 54-------------