Skynet/misc_nixos-mailserver
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: minor improvments

Browse source
This commit is contained in:
Antoine Eiche 2021-01-29 10:24:35 +01:00 committed by lewo
parent 548e6b5a04
commit 326766126c
2 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/rspamd-tuning.rst
View file

@ -5,15 +5,15 @@ SNM comes with the `rspamd spam filtering system <https://rspamd.com/>`_
enabled by default. Although its out-of-the-box performance is good, you enabled by default. Although its out-of-the-box performance is good, you
can increase its efficiency by tuning its behaviour. 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 Moving spam email to the Junk folder (and false-positives out of it) will
trigger an automatic training of the Bayesian filters, improving filtering trigger an automatic training of the Bayesian filters, improving filtering
of future emails. 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 If you kept previous spam, you can train the filter from it. Note that the
`rspamd FAQ <https://rspamd.com/doc/faq.html#how-can-i-learn-messages>`_ `rspamd FAQ <https://rspamd.com/doc/faq.html#how-can-i-learn-messages>`_
@ -36,8 +36,8 @@ You can run the training in a root shell as follows:
# Check that training was successful # Check that training was successful
rspamc -h $RSOCK stat | grep learned 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 ``X-Spamd-Result`` header is automatically added to your emails, detailing
the scoring decisions. The `modules documentation <https://rspamd.com/doc/modules/>`_ the scoring decisions. The `modules documentation <https://rspamd.com/doc/modules/>`_
@ -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. 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. 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 <https://rspamd.com/webui/>`_ that displays statistics Rspamd comes with `a web interface <https://rspamd.com/webui/>`_ that displays statistics
and history of past scans. **We do NOT recommend using it to change the configuration** and history of past scans. **We do NOT recommend using it to change the configuration**

12
docs/setup-guide.rst
View file

@ -19,8 +19,8 @@ What you need:
These will be referred to as ``domains``. As an example, These will be referred to as ``domains``. As an example,
``domains = [ example1.com, example2.com ]``. ``domains = [ example1.com, example2.com ]``.
A) Setup server Setup server
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~
The following describes a server setup that is fairly complete. Even The following describes a server setup that is fairly complete. Even
though there are more possible options (see ``default.nix``), these 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 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. 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 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. long), and sign up for some of the finest newsletters the Internet has.