aboutsummaryrefslogtreecommitdiffstats
path: root/doc/markdown
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2016-03-10 17:29:24 +0000
committerVsevolod Stakhov <vsevolod@highsecure.ru>2016-03-10 17:29:24 +0000
commit83940fa64f41f0cdba8e52326c91c8dca1588b68 (patch)
tree423ec41f168fd3569c73ac738e0ba039ed83203b /doc/markdown
parent88e0cdf0fb1b80a137a05b05ba3cbb3881457838 (diff)
downloadrspamd-83940fa64f41f0cdba8e52326c91c8dca1588b68.tar.gz
rspamd-83940fa64f41f0cdba8e52326c91c8dca1588b68.zip
[Doc] Describe new way to redefine symbols
Diffstat (limited to 'doc/markdown')
-rw-r--r--doc/markdown/tutorials/writing_rules.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/markdown/tutorials/writing_rules.md b/doc/markdown/tutorials/writing_rules.md
index 92b4b24a7..38e1f56a9 100644
--- a/doc/markdown/tutorials/writing_rules.md
+++ b/doc/markdown/tutorials/writing_rules.md
@@ -101,6 +101,35 @@ section "name" {
}
~~~
+For each individual configuration file shipped with rspamd, there are two special includes:
+
+ .include(try=true,priority=1) "$CONFDIR/local.d/config.conf"
+ .include(try=true,priority=1) "$CONFDIR/override.d/config.conf"
+
+Therefore, you can either extend (using local.d) or ultimately override (using override.d) any settings in rspamd configuration.
+
+For example, let's override some default symbols shipped with rspamd. To do that we can create and edit `etc/rspamd/local.d/metrics.conf`:
+
+ symbol "BLAH" {
+ score = 20.0;
+ }
+
+We can also use override file, for example, let's redefine actions and set more restrictive `reject` score. For these purposes, we create `etc/rspamd/override.d/metrics.conf` with the following content:
+
+ actions {
+ reject = 150;
+ add_header = 6;
+ greylist = 4;
+ }
+
+You need to set the complete objects to redefine the existing ones. For example, you **cannot** write something like
+
+ actions {
+ reject = 150;
+ }
+
+as this will set all other actions undefined.
+
The conjunction of `override` and `local` configs should allow to resolve complicated issues without having a Turing complete language to distinguish cases.
## Writing rules