From: Larry Hynes Date: Fri, 17 Jun 2016 19:02:46 +0000 (+0100) Subject: [Doc] Correct configuration/options.md X-Git-Tag: 1.3.0~296^2 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=194c4d3046e8f7a6ee40eba7e49302e77a2ae5c7;p=rspamd.git [Doc] Correct configuration/options.md --- diff --git a/doc/markdown/configuration/options.md b/doc/markdown/configuration/options.md index 29a7bde5e..0f08d3369 100644 --- a/doc/markdown/configuration/options.md +++ b/doc/markdown/configuration/options.md @@ -1,9 +1,8 @@ -# Rspamd options settings +# rspamd options settings ## Introduction -Options section defines the basic rspamd behaviour and are global for all types of workers. -The default options are depicted in the following example configuration snippet: +The options section defines basic rspamd behaviour. Options are global for all types of workers. The default options are shown in the following example snippet: ~~~ucl filters = "chartable,dkim,spf,surbl,regexp,fuzzy_check"; @@ -33,34 +32,31 @@ control_socket = "$DBDIR/rspamd.sock mode=0600"; ## Global options -* `filters`: commas separated string that defines **internal** rspamd filters enabled; for list -of the internal modules please consult with the [following page](../modules/). -* `one_shot`: if this flag is set to `true` then multiple rules triggers do not increase the total -score of messages (however, this option can be also individually configured in the `metric` section for each -symbol). -* `cache_file`: this file is used to store information about rules and their statistics; this file is automatically generated if rspamd detects that a symbols' list has been changed since last time. -* `map_watch_interval`: defines time when all maps are rescanned; the actual check interval is jittered to avoid simultaneous checking (hence, the real interval is from this value up to the this interval doubled). -* `check_all_filters`: turns off optimizations when a message gains the overall score more than the `reject` score for the default metric; this optimization can also be turned off for each request individually. -* `history_file`: this file is automatically created and refreshed on shutdown to preserve the rolling history of operations displayed by the webui across restarts. -* `temp_dir`: a directory for temporary files (also could be set via environment variable `TMPDIR`). -* `url_tld`: path to file with top level domain suffixes used by rspamd to find URL's in messages; by default this file is shipped with rspamd and should not be touched manually. -* `pid_file`: file used to store pid of the rspamd main process (not used with sytemd). -* `min_word_len`: minimum size in letters (valid for utf8 texts as well) for a sequence of characters to be treated as a word; normally rspamd skips sequences if they are shorter or equal to three symbols. -* `control_socket`: path/bind credits for the control socket +* `filters`: comma separated string that defines enabled **internal** rspamd filters; for a list of the internal filters please check the [modules page](../modules/) +* `one_shot`: if this flag is set to `true` then multiple rule triggers do not increase the total score of messages (however, this option can also be individually configured in the `metric` section for each symbol) +* `cache_file`: used to store information about rules and their statistics; this file is automatically generated if rspamd detects that a symbol's list has been changed. +* `map_watch_interval`: interval between map scanning; the actual check interval is jittered to avoid simultaneous checking, so the real interval is from this value up to 2x this value +* `check_all_filters`: turns off optimizations when a message gains an overall score more than the `reject` score for the default metric; this optimization can also be turned off for each request individually +* `history_file`: this file is automatically created and refreshed on shutdown to preserve the rolling history of operations displayed by the WebUI across restarts +* `temp_dir`: a directory for temporary files (can also be set via the environment variable `TMPDIR`). +* `url_tld`: path to file with top level domain suffixes used by rspamd to find URLs in messages; by default this file is shipped with rspamd and should not be touched manually +* `pid_file`: file used to store pid of the rspamd main process (not used with systemd) +* `min_word_len`: minimum size in letters (valid for utf-8 as well) for a sequence of characters to be treated as a word; normally rspamd skips sequences if they are shorter or equal to three symbols +* `control_socket`: path/bind for the control socket * `classify_headers`: list of headers that are processed by statistics -* `history_rows`: number of rows in the recent history roll table -* `explicit_modules`: always load modules from the list even if they have no according configuration section in the file -* `disable_hyperscan`: disable hyperscan optimizations (if enabled by compilation time) -* `cores_dir`: directory where rspamd is intended to drop core files +* `history_rows`: number of rows in the recent history table +* `explicit_modules`: always load modules from the list even if they have no configuration section in the file +* `disable_hyperscan`: disable hyperscan optimizations (if enabled at compile time) +* `cores_dir`: directory where rspamd should drop core files * `max_cores_size`: maximum total size of core files that are placed in `cores_dir` * `max_cores_count`: maximum number of files in `cores_dir` * `local_addrs` or `local_networks`: map or list of ip networks used as local, so certain checks are skipped for them (e.g. SPF checks) ## DNS options -These options live in a separate subsection named `dns` and specify the behaviour of rspamd name resolution. Here is a list of available tunables: +These options are in a separate subsection named `dns` and specify the behaviour of rspamd name resolution. Here is a list of available tunables: -* `nameserver`: list (or array) of DNS servers to be used (if this option is missed, then `/etc/resolv.conf` is parsed instead). It is also possible to specify weights of DNS servers to balance the payload, e.g. +* `nameserver`: list (or array) of DNS servers to be used (if this option is skipped, then `/etc/resolv.conf` is parsed instead). It is also possible to specify weights of DNS servers to balance the payload, e.g. ~~~ucl options { @@ -75,8 +71,8 @@ options { ~~~ * `timeout`: timeout for each DNS request -* `retransmits`: how many times each request is retransmitted to be treated as bad (the overall timeout for each request is thus `timeout * retransmits`) -* `sockets`: how many sockets are opened to a remote DNS resolver, can be tuned if you have tens thousands of requests per second). +* `retransmits`: how many times each request is retransmitted before it is treated as failed (the overall timeout for each request is thus `timeout * retransmits`) +* `sockets`: how many sockets are opened to a remote DNS resolver; can be tuned if you have tens of thousands of requests per second). ## Upstream options