diff options
author | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2015-12-17 19:01:43 +0000 |
---|---|---|
committer | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2015-12-17 19:01:43 +0000 |
commit | 6eeeb063d8864ea291f470b29b209f61c5f39dc7 (patch) | |
tree | 0a7c64f284bbb79a3bbe54370b86dff0611f721e /doc | |
parent | 760a514e84e0ba8e7dfe0840b8ee9cba47fabc88 (diff) | |
download | rspamd-6eeeb063d8864ea291f470b29b209f61c5f39dc7.tar.gz rspamd-6eeeb063d8864ea291f470b29b209f61c5f39dc7.zip |
Add normal worker documentation
Diffstat (limited to 'doc')
-rw-r--r-- | doc/markdown/workers/normal.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/markdown/workers/normal.md b/doc/markdown/workers/normal.md index e69de29bb..64cf4c479 100644 --- a/doc/markdown/workers/normal.md +++ b/doc/markdown/workers/normal.md @@ -0,0 +1,29 @@ +# Rspamd normal worker + +Rspamd normal worker is intended to scan messages for spam. It has the following configuration options available: + +* `mime`: turn to `off` if you want to scan non-mime messages (e.g. forum comments or SMS), default: `on` +* `allow_learn`: turn to `on` if you want to learn messages using this worker (usually you should use [controller](controller.md) worker), default: `off` +* `timeout`: input/output timeout, default: `1min` +* `task_timeout`: maximum time to process a single task, default: `8s` +* `max_tasks`: maximum count of tasks processes simultaneously, default: `0` - no limit +* `keypair`: encryption keypair + +## Encryption support + +To generate a keypair for the scanner you could use: + + rspamadm keypair -u + +After that keypair should appear as following: + +~~~nginx +keypair { + pubkey = "tm8zjw3ougwj1qjpyweugqhuyg4576ctg6p7mbrhma6ytjewp4ry"; + privkey = "ykkrfqbyk34i1ewdmn81ttcco1eaxoqgih38duib1e7b89h9xn3y"; +} +~~~ + +You can use its **public** part thereafter when scanning messages as following: + + rspamc --key tm8zjw3ougwj1qjpyweugqhuyg4576ctg6p7mbrhma6ytjewp4ry <file> |