From 7f76188715aed7b587c6f7ce8ecd4c0c49f703dc Mon Sep 17 00:00:00 2001 From: timo Date: Sat, 6 May 2017 16:50:21 +0200 Subject: [PATCH] Added rspamd service description --- docs/redis.md | 4 ++-- docs/rspamd.md | 9 +++++---- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/redis.md b/docs/redis.md index d7f89daf8..4f9d3be42 100644 --- a/docs/redis.md +++ b/docs/redis.md @@ -1,7 +1,7 @@ -## Client - Redis is used as a key-value store for (some of) mailcow's and rspamd's settings and data. If you are unfamilliar with redis please read the [introduction to redis](https://redis.io/topics/introduction) and maybe visit this [wonderfull guide](http://try.redis.io/) on how to use it. +## Client + To connect to the redis cli execute: ``` diff --git a/docs/rspamd.md b/docs/rspamd.md index a80b2359f..a98bee23b 100644 --- a/docs/rspamd.md +++ b/docs/rspamd.md @@ -1,4 +1,6 @@ -### Learn spam and ham +Rspamd is used for av handling, dkim signing and spam handling. It's a powerfull and fast filter system. For a more in-depth documentation on Rspamd please visit it's [own documentation](https://rspamd.com/doc/index.html). + +## Learn Spam & Ham Rspamd learns mail as spam or ham when you move a message in or out of the junk folder to any mailbox besides trash. This is archived by using the Dovecot plugin "antispam" and a simple parser script. @@ -9,7 +11,7 @@ The bayes statistics are written to Redis as keys `BAYES_HAM` and `BAYES_SPAM`. You can also use Rspamd's web ui to learn ham and/or spam. -### Learn ham or spam from existing directory +### Learn Spam or Ham from existing directory You can use a one-liner to learn mail in plain-text (uncompressed) format: ``` @@ -25,7 +27,7 @@ Consider attaching a local folder as new volume to `rspamd-mailcow` in `docker-c for file in /data/old_mail/.Junk/cur/*; do rspamc learn_spam < zcat $file; done ``` -### CLI tools +## CLI tools ``` docker-compose exec rspamd-mailcow rspamc --help @@ -33,4 +35,3 @@ docker-compose exec rspamd-mailcow rspamadm --help ``` See [Rspamd documentation](https://rspamd.com/doc/index.html) -