From 1d4a2e6231c0f9f4f9596ae6beaa3036531b53d5 Mon Sep 17 00:00:00 2001 From: Larry Hynes Date: Thu, 16 Jun 2016 22:38:45 +0100 Subject: [PATCH] [Doc] Correct configuration/settings.md --- doc/markdown/configuration/settings.md | 30 +++++++++++--------------- 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/doc/markdown/configuration/settings.md b/doc/markdown/configuration/settings.md index 00432d241..31b175344 100644 --- a/doc/markdown/configuration/settings.md +++ b/doc/markdown/configuration/settings.md @@ -1,19 +1,16 @@ -# Rspamd user settings +# rspamd user settings ## Introduction -Rspamd allows to specify custom settings according to incoming messages. Each setting define some set -of custom metric weights, symbols or actions. An administrator can also skip spam checks for certain -messages completely. Rspamd settings can be loaded as dynamic map -and updated automatically if a corresponding file or URL has changed since last update. +rspamd allows exceptional control over the settings which will apply to incoming messages. Each setting can define a set of custom metric weights, symbols or actions. An administrator can also skip spam checks for certain messages completely, if required. rspamd settings can be loaded as dynamic maps and updated automatically if a corresponding file or URL has changed since its last update. -To load settings as dynamic map, you can set 'settings' to a map string: +To load settings as a dynamic map, you can set 'settings' to a map string: ~~~ucl settings = "http://host/url" ~~~ -If you don't want dynamic updates then you can set settings to an object: +If you don't want dynamic updates then you can define settings as an object: ~~~ucl settings { @@ -28,7 +25,7 @@ settings { ## Settings structure -The settings file itself should contain a single section called "settings": +The settings file should contain a single section called "settings": ~~~ucl settings { @@ -45,7 +42,7 @@ settings { actions { reject = 100.0; greylist = 10.0; - "add header" = 5.0; # Please mention a space instead of underscore + "add header" = 5.0; # Please note the space, NOT an underscore } } # Always add these symbols when settings rule has matched @@ -63,24 +60,21 @@ settings { So each setting has the following attributes: -- `name` - section name that identify this specific setting (e.g. `some_users`) -- `priority` - high or low, high priority rules are matched first (default priority is low) -- `match list` - list of rules when this rule matches: +- `name` - section name that identifies this specific setting (e.g. `some_users`) +- `priority` - high or low; high priority rules are matched first (default priority is low) +- `match list` - list of rules which this rule matches: + `from` - match SMTP from + `rcpt` - match RCPT + `ip` - match source IP address + `user` - matches authenticated user ID of message sender if any - `apply` - list of applied rules, identified by metric name (e.g. `default`) + `symbol` - modify weight of a symbol - + `actions` - section of modified actions + + `actions` - defines actions - `symbols` - add symbols from the list if a rule has matched -Match section performs `AND` operation on different matches, for example, if you have -`from` and `rcpt` in the same rule, then rule matches only when `from` `AND` `rcpt` match. -For the same matches `OR` rule applies. Therefore, if you have multiple `rcpt` matches, then any of -these `rcpt` will trigger the rule. If a setting applies no more rules are matched. +The match section performs `AND` operation on different matches: for example, if you have `from` and `rcpt` in the same rule, then the rule matches only when `from` `AND` `rcpt` match. For similar matches, the `OR` rule applies: if you have multiple `rcpt` matches, then *any* of these will trigger the rule. If a rule is triggered then no more rules are matched. -Regexp rules are slow and should not be used intensively. All other rules are matched fast enough. +Regexp rules can be slow and should not be used extensively. The picture below describes the architecture of settings matching. -- 2.39.5