From 326766126cea11ed94b772bdc79d8b5ccb228957 Mon Sep 17 00:00:00 2001 From: Antoine Eiche Date: Fri, 29 Jan 2021 10:24:35 +0100 Subject: [PATCH] doc: minor improvments --- docs/rspamd-tuning.rst | 20 ++++++++++---------- docs/setup-guide.rst | 12 ++++++------ 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/rspamd-tuning.rst b/docs/rspamd-tuning.rst index 46886f2..049858d 100644 --- a/docs/rspamd-tuning.rst +++ b/docs/rspamd-tuning.rst @@ -5,15 +5,15 @@ SNM comes with the `rspamd spam filtering system `_ enabled by default. Although its out-of-the-box performance is good, you can increase its efficiency by tuning its behaviour. -A) Auto-learning -~~~~~~~~~~~~~~~~ +Auto-learning +~~~~~~~~~~~~~ Moving spam email to the Junk folder (and false-positives out of it) will trigger an automatic training of the Bayesian filters, improving filtering of future emails. -B) Train from existing folders -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Train from existing folders +~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you kept previous spam, you can train the filter from it. Note that the `rspamd FAQ `_ @@ -36,8 +36,8 @@ You can run the training in a root shell as follows: # Check that training was successful rspamc -h $RSOCK stat | grep learned -C) Tune symbol weight -~~~~~~~~~~~~~~~~~~~~~ +Tune symbol weight +~~~~~~~~~~~~~~~~~~ The ``X-Spamd-Result`` header is automatically added to your emails, detailing the scoring decisions. The `modules documentation `_ @@ -52,8 +52,8 @@ details the meaning of each symbol. You can tune the weight if a symbol if neede }''; }; -D) Tune action thresholds -~~~~~~~~~~~~~~~~~~~~~~~~~ +Tune action thresholds +~~~~~~~~~~~~~~~~~~~~~~ After scoring the message, rspamd decides on an action based on configurable thresholds. By default, rspamd will tell postfix to reject any message with a score higher than 15. @@ -71,8 +71,8 @@ this behaviour by tuning the configuration. For example: ''; -E) Access the rspamd web UI -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Access the rspamd web UI +~~~~~~~~~~~~~~~~~~~~~~~~ Rspamd comes with `a web interface `_ that displays statistics and history of past scans. **We do NOT recommend using it to change the configuration** diff --git a/docs/setup-guide.rst b/docs/setup-guide.rst index e582e90..3f80624 100644 --- a/docs/setup-guide.rst +++ b/docs/setup-guide.rst @@ -19,8 +19,8 @@ What you need: These will be referred to as ``domains``. As an example, ``domains = [ example1.com, example2.com ]``. -A) Setup server -~~~~~~~~~~~~~~~ +Setup server +~~~~~~~~~~~~ The following describes a server setup that is fairly complete. Even though there are more possible options (see ``default.nix``), these @@ -125,8 +125,8 @@ the following minimal ``flake.nix`` as an example: }; } -B) Setup everything else -~~~~~~~~~~~~~~~~~~~~~~~~ +Setup everything else +~~~~~~~~~~~~~~~~~~~~~ Step 1: Set DNS entry for server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -269,8 +269,8 @@ last section. Note that it can take a while until a DNS entry is propagated. -C) Test your Setup -~~~~~~~~~~~~~~~~~~ +Test your Setup +~~~~~~~~~~~~~~~ Write an email to your aunt (who has been waiting for your reply far too long), and sign up for some of the finest newsletters the Internet has.