From 272c19c218ab793d5413ff2c7747fb8e8932da5a Mon Sep 17 00:00:00 2001 From: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com> Date: Wed, 10 May 2023 11:51:49 +0200 Subject: [PATCH] docs: update Rspamd docs (small improvement) (#3318) --- docs/content/config/security/rspamd.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/docs/content/config/security/rspamd.md b/docs/content/config/security/rspamd.md index d61a7c4a..e837057d 100644 --- a/docs/content/config/security/rspamd.md +++ b/docs/content/config/security/rspamd.md @@ -156,15 +156,30 @@ ENABLE_AMAVIS=0 ENABLE_SPAMASSASSIN=0 ``` -This will enable Rspamd and disable services you don't need when using Rspamd. Note that with this setup, the default DKIM signing that DMS provides does not work (as it is disabled)! To solve this issue, look at [this subsection](#dkim-signing). +This will enable Rspamd and disable services you don't need when using Rspamd. ### Adjusting and Extending The Very Basic Configuration -Rspamd is running, but you want or need to adjust it? +Rspamd is running, but you want or need to adjust it? First, create a file named `custom-commands.conf` under `docker-data/dms/config/rspamd` (which translates to `/tmp/docker-mailserver/rspamd/` inside the container). Then add you changes: -1. Say you want to be able to easily look at the frontend Rspamd provides on port 11334 (default) without the need to enter a password (maybe because you already provide authorization and authentication). You will need to adjust the controller worker: create a file called `custom-commands.conf` and add the line `set-option-for-controller secure_ip "0.0.0.0/0"`. Place the file `custom-commands.conf` inside the directory on the host you mount to `/tmp/docker-mailserver/rspamd/` inside the container (in our documentation, we use `docker-data/dms/config/rspamd/` on the host for this purpose). And you're done! Note: this disables authentication on the website - make sure you know what you're doing! -2. You additionally want to enable the auto-spam-learning for the Bayes module? No problem, just add another line to `custom-commands.conf` that looks like this: `set-option-for-module classifier-bayes autolearn true`. -3. But the chartable module gets on your nerves? Just disable it by adding another line: `disable-module chartable`. +1. Say you want to be able to easily look at the frontend Rspamd provides on port 11334 (default) without the need to enter a password (maybe because you already provide authorization and authentication). You will need to adjust the controller worker: `set-option-for-controller secure_ip "0.0.0.0/0"`. +2. You additionally want to enable the auto-spam-learning for the Bayes module? No problem: `set-option-for-module classifier-bayes autolearn true`. +3. But the chartable module gets on your nerves? Easy: `disable-module chartable`. + +??? example "What Does the Result Look Like?" + Here is what the file looks like in the end: + + ```bash + # See 1. + # ATTENTION: this disables authentication on the website - make sure you know what you're doing! + set-option-for-controller secure_ip "0.0.0.0/0" + + # See 2. + set-option-for-module classifier-bayes autolearn true + + # See 3. + disable-module chartable + ``` ### DKIM Signing