summaryrefslogtreecommitdiffstats
path: root/doc/markdown/configuration/index.md
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2016-07-08 11:32:43 +0100
committerVsevolod Stakhov <vsevolod@highsecure.ru>2016-07-08 11:32:43 +0100
commitce2688ea374d49cac7fd3cbb669f0d50d606f0d3 (patch)
tree6b3de5213b61036d9fd306fcb2cfa7daea0b850c /doc/markdown/configuration/index.md
parentdcf3b7caff4fe32a42d1dbdfa92e874c8ae0b74c (diff)
downloadrspamd-ce2688ea374d49cac7fd3cbb669f0d50d606f0d3.tar.gz
rspamd-ce2688ea374d49cac7fd3cbb669f0d50d606f0d3.zip
[Doc] Massive documentation rework
Diffstat (limited to 'doc/markdown/configuration/index.md')
-rw-r--r--doc/markdown/configuration/index.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/markdown/configuration/index.md b/doc/markdown/configuration/index.md
index 6d480b7c0..6cc5e049e 100644
--- a/doc/markdown/configuration/index.md
+++ b/doc/markdown/configuration/index.md
@@ -1,25 +1,25 @@
-# rspamd configuration
+# Rspamd configuration
-rspamd uses the Universal Configuration Language (UCL) for its configuration. The UCL format is described in detail in this [document](ucl.md). rspamd defines several variables and macros to extend
+rspamd uses the Universal Configuration Language (UCL) for its configuration. The UCL format is described in detail in this [document](ucl.md). Rspamd defines several variables and macros to extend
UCL functionality.
-## rspamd variables
+## Rspamd variables
-- *CONFDIR*: configuration directory for rspamd, found in `$PREFIX/etc/rspamd/`
+- *CONFDIR*: configuration directory for Rspamd, found in `$PREFIX/etc/rspamd/`
- *RUNDIR*: runtime directory to store pidfiles or unix sockets
- *DBDIR*: persistent databases directory (used for statistics or symbols cache).
- *LOGDIR*: a directory to store log files
- *PLUGINSDIR*: plugins directory for lua plugins
- *PREFIX*: basic installation prefix
-- *VERSION*: rspamd version string (e.g. "0.6.6")
+- *VERSION*: Rspamd version string (e.g. "0.6.6")
-## rspamd specific macros
+## Rspamd specific macros
- *.include_map*: defines a map that is dynamically reloaded and updated if its content has changed. This macro is intended to define dynamic configuration files.
-## rspamd basic configuration
+## Rspamd basic configuration
-The basic rspamd configuration is stored in `$CONFDIR/rspamd.conf`. By default, this file looks like this one:
+The basic Rspamd configuration is stored in `$CONFDIR/rspamd.conf`. By default, this file looks like this one:
~~~ucl
lua = "$CONFDIR/lua/rspamd.lua"
@@ -39,7 +39,7 @@ modules {
}
~~~
-In this file, we read a lua script placed in `$CONFDIR/lua/rspamd.lua` and load lua rules from it. Then we include a global [options](options.md) section followed by [logging](logging.md) logging configuration. The [metrics](metrics.md) section defines metric settings, including rule weights and rspamd actions. The [workers](../workers/index.md) section specifies rspamd workers settings. [Composites](composites.md) is a utility section that describes composite symbols. Statistical filters are defined in the [statistic](statistic.md) section. rspamd stores module configurations (for both lua and internal modules) in the [modules](../modules/index.md) section while modules themselves are loaded from the following portion of the configuration:
+In this file, we read a lua script placed in `$CONFDIR/lua/rspamd.lua` and load lua rules from it. Then we include a global [options](options.md) section followed by [logging](logging.md) logging configuration. The [metrics](metrics.md) section defines metric settings, including rule weights and Rspamd actions. The [workers](../workers/index.md) section specifies Rspamd workers settings. [Composites](composites.md) is a utility section that describes composite symbols. Statistical filters are defined in the [statistic](statistic.md) section. Rspamd stores module configurations (for both lua and internal modules) in the [modules](../modules/index.md) section while modules themselves are loaded from the following portion of the configuration:
~~~ucl
modules {
@@ -49,4 +49,4 @@ modules {
The modules section defines the path or paths of directories or specific files. If a directory is specified then all files with a `.lua` suffix are loaded as lua plugins (the directory path is treated as a `*.lua` shell pattern).
-This configuration is not intended to be changed by the user, rather you can include your own configuration options as `.include`s. To redefine symbol weights and actions, it is recommended to use [dynamic configuration](settings.md). Nevertheless, the rspamd installation script will never overwrite a user's configuration if it exists already. Please read the rspamd changelog carefully, if you upgrade rspamd to a new version, for all incompatible configuration changes.
+This configuration is not intended to be changed by the user, rather you can include your own configuration options as `.include`s. To redefine symbol weights and actions, it is recommended to use [dynamic configuration](settings.md). Nevertheless, the Rspamd installation script will never overwrite a user's configuration if it exists already. Please read the Rspamd changelog carefully, if you upgrade Rspamd to a new version, for all incompatible configuration changes.