mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
docs: SpamAssassin ENV docs refactor (#3756)
* chore: Log `SPAMASSASSIN_SPAM_TO_INBOX=1` ENV correctly ENV name logged was incomplete. * docs: Update SA related ENV docs * fix: Log level `warning` should be `warn` * docs: FAQ - Revise outdated SA entry * chore: Antispam / Antivirus => Anti-spam / Anti-virus * docs: ENV - Additional revisions to SA ENV * docs: ENV - Move `ENABLE_SPAMASSASSIN_KAM`
This commit is contained in:
Brennan Kinney
GitHub
parent
8e20173200
commit
5e28c17cf4
|
|
@ -13,6 +13,9 @@ All notable changes to this project will be documented in this file. The format
|
|||
- Postfix is now configured with `smtputf8_enable = no` in our default `main.cf` config (_instead of during container startup_). ([#3750](https://github.com/docker-mailserver/docker-mailserver/pull/3750))
|
||||
- **Rspamd** ([#3726](https://github.com/docker-mailserver/docker-mailserver/pull/3726)):
|
||||
- symbol scores for SPF, DKIM & DMARC were updated to more closely align with [RFC7489](https://www.rfc-editor.org/rfc/rfc7489#page-24); please note though that complete alignment is undesirable, because other symbols might be added as well, which changes the overall score calculation again, see [this issue](https://github.com/docker-mailserver/docker-mailserver/issues/3690#issuecomment-1866871996)
|
||||
- **Docs:**
|
||||
- Revised the SpamAssassin ENV docs to better communicate configuration and their relation to other ENV settings. ([#3756](https://github.com/docker-mailserver/docker-mailserver/pull/3756))
|
||||
|
||||
|
||||
### Fixes
|
||||
|
||||
|
|
|
|||
|
|
@ -319,7 +319,7 @@ LABEL org.opencontainers.image.title="docker-mailserver"
|
|||
LABEL org.opencontainers.image.vendor="The Docker Mailserver Organization"
|
||||
LABEL org.opencontainers.image.authors="The Docker Mailserver Organization on GitHub"
|
||||
LABEL org.opencontainers.image.licenses="MIT"
|
||||
LABEL org.opencontainers.image.description="A fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.). Only configuration files, no SQL database."
|
||||
LABEL org.opencontainers.image.description="A fullstack but simple mail server (SMTP, IMAP, LDAP, Anti-spam, Anti-virus, etc.). Only configuration files, no SQL database."
|
||||
LABEL org.opencontainers.image.url="https://github.com/docker-mailserver"
|
||||
LABEL org.opencontainers.image.documentation="https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md"
|
||||
LABEL org.opencontainers.image.source="https://github.com/docker-mailserver/docker-mailserver"
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
|
||||
## :page_with_curl: About
|
||||
|
||||
A production-ready fullstack but simple containerized mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.). Only configuration files, no SQL database. Keep it simple and versioned. Easy to deploy and upgrade. Originally created by @tomav, this project is now maintained by volunteers since January 2021.
|
||||
A production-ready fullstack but simple containerized mail server (SMTP, IMAP, LDAP, Anti-spam, Anti-virus, etc.). Only configuration files, no SQL database. Keep it simple and versioned. Easy to deploy and upgrade. Originally created by @tomav, this project is now maintained by volunteers since January 2021.
|
||||
|
||||
## :bulb: Documentation
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ This is a list of all configuration files and directories which are optional or
|
|||
- **ldap-aliases.cf:** Configuration for the virtual alias mapping `virtual_alias_maps`. See the [`setup-stack.sh`][github-commit-setup-stack.sh-L411] script.
|
||||
- **ldap-domains.cf:** Configuration for the virtual domain mapping `virtual_mailbox_domains`. See the [`setup-stack.sh`][github-commit-setup-stack.sh-L411] script.
|
||||
- **whitelist_clients.local:** Whitelisted domains, not considered by postgrey. Enter one host or domain per line.
|
||||
- **spamassassin-rules.cf:** Antispam rules for Spamassassin. (Docs: [FAQ - SpamAssassin Rules][docs-faq-spamrules])
|
||||
- **spamassassin-rules.cf:** Anti-spam rules for Spamassassin. (Docs: [FAQ - SpamAssassin Rules][docs-faq-spamrules])
|
||||
- **fail2ban-fail2ban.cf:** Additional config options for `fail2ban.cf`. (Docs: [Fail2Ban][docs-fail2ban])
|
||||
- **fail2ban-jail.cf:** Additional config options for fail2ban's jail behaviour. (Docs: [Fail2Ban][docs-fail2ban])
|
||||
- **amavis.cf:** replaces the `/etc/amavis/conf.d/50-user` file
|
||||
|
|
|
|||
|
|
@ -316,28 +316,32 @@ Note: More information at <https://dovecot.org/doc/dovecot-example.conf>
|
|||
|
||||
##### MOVE_SPAM_TO_JUNK
|
||||
|
||||
When enabled, e-mails marked with the
|
||||
|
||||
1. `X-Spam: Yes` header added by Rspamd
|
||||
2. `X-Spam-Flag: YES` header added by SpamAssassin (requires [`SPAMASSASSIN_SPAM_TO_INBOX=1`](#spamassassin_spam_to_inbox))
|
||||
|
||||
will be automatically moved to the Junk folder (with the help of a Sieve script).
|
||||
|
||||
- 0 => Spam messages will be delivered in the mailbox.
|
||||
- **1** => Spam messages will be delivered in the `Junk` folder.
|
||||
|
||||
Routes mail identified as spam into the recipient(s) Junk folder (_via a Dovecot Sieve script_).
|
||||
|
||||
!!! info
|
||||
|
||||
Mail is received as spam when it has been marked with either header:
|
||||
|
||||
- `X-Spam: Yes` (_added by Rspamd_)
|
||||
- `X-Spam-Flag: YES` (_added by SpamAssassin - requires [`SPAMASSASSIN_SPAM_TO_INBOX=1`](#spamassassin_spam_to_inbox)_)
|
||||
|
||||
##### MARK_SPAM_AS_READ
|
||||
|
||||
Enable to treat received spam as "read" (_avoids notification to MUA client of new mail_).
|
||||
|
||||
Mail is received as spam when it has been marked with either header:
|
||||
|
||||
1. `X-Spam: Yes` (_by Rspamd_)
|
||||
2. `X-Spam-Flag: YES` (_by SpamAssassin - requires [`SPAMASSASSIN_SPAM_TO_INBOX=1`](#spamassassin_spam_to_inbox)_)
|
||||
|
||||
- **0** => disabled
|
||||
- 1 => Spam messages will be marked as read
|
||||
|
||||
Enable to treat received spam as "read" (_avoids notification to MUA client of new mail_).
|
||||
|
||||
!!! info
|
||||
|
||||
Mail is received as spam when it has been marked with either header:
|
||||
|
||||
- `X-Spam: Yes` (_added by Rspamd_)
|
||||
- `X-Spam-Flag: YES` (_added by SpamAssassin - requires [`SPAMASSASSIN_SPAM_TO_INBOX=1`](#spamassassin_spam_to_inbox)_)
|
||||
|
||||
#### Rspamd
|
||||
|
||||
##### ENABLE_RSPAMD
|
||||
|
|
@ -515,63 +519,170 @@ Changes the interval in which log files are rotated.
|
|||
- **0** => SpamAssassin is disabled
|
||||
- 1 => SpamAssassin is enabled
|
||||
|
||||
##### SPAMASSASSIN_SPAM_TO_INBOX
|
||||
??? info "SpamAssassin analyzes incoming mail and assigns a spam score"
|
||||
|
||||
- 0 => Spam messages will be bounced (_rejected_) without any notification (_dangerous_).
|
||||
- **1** => Spam messages will be delivered to the inbox and tagged as spam using `SA_SPAM_SUBJECT`.
|
||||
Integration with Amavis involves processing mail based on the assigned spam score via [`SA_TAG`, `SA_TAG2` and `SA_KILL`][amavis-docs::spam-score].
|
||||
|
||||
These settings have equivalent ENV supported by DMS for easy adjustments, as documented below.
|
||||
|
||||
[amavis-docs::spam-score]: https://www.ijs.si/software/amavisd/amavisd-new-docs.html#tagkill
|
||||
|
||||
##### ENABLE_SPAMASSASSIN_KAM
|
||||
|
||||
[KAM](https://mcgrail.com/template/projects#KAM1) is a 3rd party SpamAssassin ruleset, provided by the McGrail Foundation. If SpamAssassin is enabled, KAM can be used in addition to the default ruleset.
|
||||
|
||||
- **0** => KAM disabled
|
||||
- 1 => KAM enabled
|
||||
|
||||
[KAM](https://mcgrail.com/template/projects#KAM1) is a 3rd party SpamAssassin ruleset, provided by the McGrail Foundation. If SpamAssassin is enabled, KAM can be used in addition to the default ruleset.
|
||||
|
||||
##### SPAMASSASSIN_SPAM_TO_INBOX
|
||||
|
||||
- 0 => (_Amavis action: `D_BOUNCE`_): Spam messages will be bounced (_rejected_) without any notification (_dangerous_).
|
||||
- **1** => (_Amavis action: `D_PASS`_): Spam messages will be delivered to the inbox.
|
||||
|
||||
!!! note
|
||||
|
||||
The Amavis action configured by this setting:
|
||||
|
||||
- Influences the behaviour of the [`SA_KILL`](#sa_kill) setting.
|
||||
- Applies to the Amavis config parameters `$final_spam_destiny` and `$final_bad_header_destiny`.
|
||||
|
||||
!!! note "This ENV setting is related to"
|
||||
|
||||
- [`MOVE_SPAM_TO_JUNK=1`](#move_spam_to_junk)
|
||||
- [`MARK_SPAM_AS_READ=1`](#mark_spam_as_read)
|
||||
- [`SA_SPAM_SUBJECT`](#sa_spam_subject)
|
||||
|
||||
##### SA_TAG
|
||||
|
||||
- **2.0** => add spam info headers if at, or above that level
|
||||
- **2.0** => add 'spam info' headers at, or above this spam score
|
||||
|
||||
Note: this SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`
|
||||
Mail is not yet considered spam at this spam score, but for purposes like diagnostics it can be useful to identify mail with a spam score at a lower bound than `SA_TAG2`.
|
||||
|
||||
??? example "`X-Spam` headers appended to mail"
|
||||
|
||||
Send a simple mail to a local DMS account `hello@example.com`:
|
||||
|
||||
```bash
|
||||
docker exec dms swaks --server 0.0.0.0 --to hello@example.com --body 'spam'
|
||||
```
|
||||
|
||||
Inspecting the raw mail you will notice several `X-Spam` headers were added to the mail like this:
|
||||
|
||||
```
|
||||
X-Spam-Flag: NO
|
||||
X-Spam-Score: 4.162
|
||||
X-Spam-Level: ****
|
||||
X-Spam-Status: No, score=4.162 tagged_above=2 required=4
|
||||
tests=[BODY_SINGLE_WORD=1, DKIM_ADSP_NXDOMAIN=0.8,
|
||||
NO_DNS_FOR_FROM=0.379, NO_RECEIVED=-0.001, NO_RELAYS=-0.001,
|
||||
PYZOR_CHECK=1.985] autolearn=no autolearn_force=no
|
||||
```
|
||||
|
||||
!!! info "The `X-Spam-Score` is `4.162`"
|
||||
|
||||
High enough for `SA_TAG` to trigger adding these headers, but not high enough for `SA_TAG2` (_which would set `X-Spam-Flag: YES` instead_).
|
||||
|
||||
##### SA_TAG2
|
||||
|
||||
- **6.31** => add 'spam detected' headers at that level
|
||||
- **6.31** => add 'spam detected' headers at, or above this level
|
||||
|
||||
Note: this SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`
|
||||
When a spam score is high enough, mark mail as spam (_Appends the mail header: `X-Spam-Flag: YES`_).
|
||||
|
||||
!!! info "Interaction with other ENV"
|
||||
|
||||
- [`SA_SPAM_SUBJECT`](#sa_spam_subject) modifies the mail subject to better communicate spam mail to the user.
|
||||
- [`MOVE_SPAM_TO_JUNK=1`](#move_spam_to_junk): The mail is still delivered, but to the recipient(s) junk folder instead. This feature reduces the usefulness of `SA_SPAM_SUBJECT`.
|
||||
|
||||
##### SA_KILL
|
||||
|
||||
- **10.0** => triggers spam evasive actions
|
||||
- **10.0** => quarantine + triggers action to handle spam
|
||||
|
||||
!!! note "This SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`"
|
||||
Controls the spam score threshold for triggering an action on mail that has a high spam score.
|
||||
|
||||
By default, DMS is configured to quarantine spam emails.
|
||||
??? tip "Choosing an appropriate `SA_KILL` value"
|
||||
|
||||
If emails are quarantined, they are compressed and stored in a location dependent on the `ONE_DIR` setting above. To inhibit this behaviour and deliver spam emails, set this to a very high value e.g. `100.0`.
|
||||
The value should be high enough to be represent confidence in mail as spam:
|
||||
|
||||
If `ONE_DIR=1` (default) the location is `/var/mail-state/lib-amavis/virusmails/`, or if `ONE_DIR=0`: `/var/lib/amavis/virusmails/`. These paths are inside the docker container.
|
||||
- Too low: The action taken may prevent legitimate mail (ham) that was incorrectly detected as spam from being delivered successfully.
|
||||
- Too high: Allows more spam to bypass the `SA_KILL` trigger (_how to treat mail with high confidence that it is actually spam_).
|
||||
|
||||
Experiences from DMS users with these settings has been [collected here][gh-issue::sa-tunables-insights], along with [some direct configuration guides][gh-issue::sa-tunables-guides] (_under "Resources for references"_).
|
||||
|
||||
[gh-issue::sa-tunables-insights]: https://github.com/docker-mailserver/docker-mailserver/pull/3058#issuecomment-1420268148
|
||||
[gh-issue::sa-tunables-guides]: https://github.com/docker-mailserver/docker-mailserver/pull/3058#issuecomment-1416547911
|
||||
|
||||
??? info "Trigger action"
|
||||
|
||||
DMS will configure Amavis with either of these actions based on the DMS [`SPAMASSASSIN_SPAM_TO_INBOX`](#spamassassin_spam_to_inbox) ENV setting:
|
||||
|
||||
- `D_PASS` (**default**):
|
||||
- Accept mail and deliver it to the recipient(s), despite the high spam score. A copy is still stored in quarantine.
|
||||
- This is a good default to start with until you are more confident in an `SA_KILL` threshold that won't accidentally discard / bounce legitimate mail users are expecting to arrive but is detected as spam.
|
||||
- `D_BOUNCE`:
|
||||
- Additionally sends a bounce notification (DSN).
|
||||
- The [DSN is suppressed][amavis-docs::actions] (_no bounce sent_) when the spam score exceeds the Amavis `$sa_dsn_cutoff_level` config setting (default: `10`). With the DMS `SA_KILL` default also being `10`, no DSN will ever be sent.
|
||||
- `D_REJECT` / `D_DISCARD`:
|
||||
- These two aren't configured by DMS, but are valid alternative action values if configuring Amavis directly.
|
||||
|
||||
??? note "Quarantined mail"
|
||||
|
||||
When mail has a spam score that reaches the `SA_KILL` threshold:
|
||||
|
||||
- [It will be quarantined][amavis-docs::quarantine] regardless of the `SA_KILL` action to perform.
|
||||
- With `D_PASS` the delivered mail also appends an `X-Quarantine-ID` mail header. The ID value of this header is part of the quarantined file name.
|
||||
|
||||
If emails are quarantined, they are compressed and stored at a location dependent on the [`ONE_DIR`](#one_dir) setting:
|
||||
|
||||
- `ONE_DIR=1` (default): `/var/mail-state/lib-amavis/virusmails/`
|
||||
- `ONE_DIR=0`: `/var/lib/amavis/virusmails/`
|
||||
|
||||
!!! tip
|
||||
|
||||
Easily list mail stored in quarantine with `find` and the quarantine path:
|
||||
|
||||
```bash
|
||||
find /var/lib/amavis/virusmails -type f
|
||||
```
|
||||
|
||||
[amavis-docs::actions]: https://www.ijs.si/software/amavisd/amavisd-new-docs.html#actions
|
||||
[amavis-docs::quarantine]: https://www.ijs.si/software/amavisd/amavisd-new-docs.html#quarantine
|
||||
|
||||
##### SA_SPAM_SUBJECT
|
||||
|
||||
- **\*\*\*SPAM\*\*\*** => add tag to subject if spam detected
|
||||
Adds a prefix to the subject header when mail is marked as spam (_via [`SA_TAG2`](#sa_tag2)_).
|
||||
|
||||
Note: this SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`. Add the SpamAssassin score to the subject line by inserting the keyword \_SCORE\_: **\*\*\*SPAM(\_SCORE\_)\*\*\***.
|
||||
- **`'***SPAM*** '`** => A string value to use as a mail subject prefix.
|
||||
- `undef` => Opt-out of modifying the subject for mail marked as spam.
|
||||
|
||||
??? example "Including trailing white-space"
|
||||
|
||||
Add trailing white-space by quote wrapping the value: `SA_SPAM_SUBJECT='[SPAM] '`
|
||||
|
||||
??? example "Including the associated spam score"
|
||||
|
||||
The [`_SCORE_` tag][sa-docs::score-tag] will be substituted with the SpamAssassin score: `SA_SPAM_SUBJECT=***SPAM(_SCORE_)***`.
|
||||
|
||||
[sa-docs::score-tag]: https://spamassassin.apache.org/full/4.0.x/doc/Mail_SpamAssassin_Conf.html#rewrite_header-subject-from-to-STRING
|
||||
|
||||
##### SA_SHORTCIRCUIT_BAYES_SPAM
|
||||
|
||||
- **1** => will activate SpamAssassin short circuiting for bayes spam detection.
|
||||
|
||||
This will uncomment the respective line in ```/etc/spamassasin/local.cf```
|
||||
This will uncomment the respective line in `/etc/spamassasin/local.cf`
|
||||
|
||||
Note: activate this only if you are confident in your bayes database for identifying spam.
|
||||
!!! warning
|
||||
|
||||
Activate this only if you are confident in your bayes database for identifying spam.
|
||||
|
||||
##### SA_SHORTCIRCUIT_BAYES_HAM
|
||||
|
||||
- **1** => will activate SpamAssassin short circuiting for bayes ham detection
|
||||
|
||||
This will uncomment the respective line in ```/etc/spamassasin/local.cf```
|
||||
This will uncomment the respective line in `/etc/spamassasin/local.cf`
|
||||
|
||||
Note: activate this only if you are confident in your bayes database for identifying ham.
|
||||
!!! warning
|
||||
|
||||
Activate this only if you are confident in your bayes database for identifying ham.
|
||||
|
||||
#### Fetchmail
|
||||
|
||||
|
|
|
|||
|
|
@ -378,18 +378,7 @@ When you run DMS with the ENV variable `ONE_DIR=1` (default), this directory wil
|
|||
|
||||
#### How can I manage my custom SpamAssassin rules?
|
||||
|
||||
Antispam rules are managed in `docker-data/dms/config/spamassassin-rules.cf`.
|
||||
|
||||
#### What are acceptable `SA_SPAM_SUBJECT` values?
|
||||
|
||||
For no subject set `SA_SPAM_SUBJECT=undef`.
|
||||
|
||||
For a trailing white-space subject one can define the whole variable with quotes in `compose.yaml`:
|
||||
|
||||
```yaml
|
||||
environment:
|
||||
- "SA_SPAM_SUBJECT=[SPAM] "
|
||||
```
|
||||
Anti-spam rules are managed in `docker-data/dms/config/spamassassin-rules.cf`.
|
||||
|
||||
#### Why are SpamAssassin `x-headers` not inserted into my `subdomain.example.com` subdomain emails?
|
||||
|
||||
|
|
@ -479,59 +468,39 @@ The following configuration works nicely:
|
|||
file: ./docker-data/dms/cron/sa-learn
|
||||
```
|
||||
|
||||
With the default settings, SpamAssassin will require 200 mails trained for spam (for example with the method explained above) and 200 mails trained for ham (using the same command as above but using `--ham` and providing it with some ham mails). Until you provided these 200+200 mails, SpamAssassin will not take the learned mails into account. For further reference, see the [SpamAssassin Wiki](https://wiki.apache.org/spamassassin/BayesNotWorking).
|
||||
With the default settings, SpamAssassin will require 200 mails trained for spam (for example with the method explained above) and 200 mails trained for ham (using the same command as above but using `--ham` and providing it with some ham mails).
|
||||
|
||||
- Until you provided these 200+200 mails, SpamAssassin will not take the learned mails into account.
|
||||
- For further reference, see the [SpamAssassin Wiki](https://wiki.apache.org/spamassassin/BayesNotWorking).
|
||||
|
||||
#### How do I have more control about what SpamAssassin is filtering?
|
||||
|
||||
By default, SPAM and INFECTED emails are put to a quarantine which is not very straight forward to access. Several config settings are affecting this behavior:
|
||||
This is related to Amavis processing the mail after SpamAssassin has analyzed it and assigned a spam score.
|
||||
|
||||
First, make sure you have the proper thresholds set:
|
||||
- DMS provides some [common SA tunables via ENV][docs::env::sa_env].
|
||||
- Additional configuration can be managed with the DMS config volume by providing `docker-data/dms/config/amavis.cf`.
|
||||
|
||||
```conf
|
||||
SA_TAG=-100000.0
|
||||
SA_TAG2=3.75
|
||||
SA_KILL=100000.0
|
||||
```
|
||||
#### How can I send quarantined mail to a mailbox?
|
||||
|
||||
- The very negative value in `SA_TAG` makes sure, that all emails have the SpamAssassin headers included.
|
||||
- `SA_TAG2` is the actual threshold to set the YES/NO flag for spam detection.
|
||||
- `SA_KILL` needs to be very high, to make sure nothing is bounced at all (`SA_KILL` superseeds `SPAMASSASSIN_SPAM_TO_INBOX`)
|
||||
SPAM and INFECTED emails that [reach the `SA_KILL` threshold are archived into quarantine][docs::env::sa_kill].
|
||||
|
||||
Make sure everything (including SPAM) is delivered to the inbox and not quarantined:
|
||||
|
||||
```conf
|
||||
SPAMASSASSIN_SPAM_TO_INBOX=1
|
||||
```
|
||||
|
||||
Use `MOVE_SPAM_TO_JUNK=1` or create a sieve script which puts spam to the Junk folder:
|
||||
|
||||
```sieve
|
||||
require ["comparator-i;ascii-numeric","relational","fileinto"];
|
||||
|
||||
if header :contains "X-Spam-Flag" "YES" {
|
||||
fileinto "Junk";
|
||||
} elsif allof (
|
||||
not header :matches "x-spam-score" "-*",
|
||||
header :value "ge" :comparator "i;ascii-numeric" "x-spam-score" "3.75"
|
||||
) {
|
||||
fileinto "Junk";
|
||||
}
|
||||
```
|
||||
|
||||
Create a dedicated mailbox for emails which are infected/bad header and everything amavis is blocking by default and put its address into `docker-data/dms/config/amavis.cf`
|
||||
Instead of a quarantine folder, you can use a dedicated mailbox instead. Create an account like `quarantine@example.com` and create `docker-data/dms/config/amavis.cf`:
|
||||
|
||||
```cf
|
||||
$clean_quarantine_to = "amavis\@example.com";
|
||||
$virus_quarantine_to = "amavis\@example.com";
|
||||
$banned_quarantine_to = "amavis\@example.com";
|
||||
$bad_header_quarantine_to = "amavis\@example.com";
|
||||
$spam_quarantine_to = "amavis\@example.com";
|
||||
$clean_quarantine_to = "quarantine\@example.com";
|
||||
$virus_quarantine_to = "quarantine\@example.com";
|
||||
$banned_quarantine_to = "quarantine\@example.com";
|
||||
$bad_header_quarantine_to = "quarantine\@example.com";
|
||||
$spam_quarantine_to = "quarantine\@example.com";
|
||||
```
|
||||
|
||||
[fail2ban-customize]: ./config/security/fail2ban.md
|
||||
[docs-maintenance]: ./config/advanced/maintenance/update-and-cleanup.md
|
||||
[docs-override-postfix]: ./config/advanced/override-defaults/postfix.md
|
||||
[docs-userpatches]: ./config/advanced/override-defaults/user-patches.md
|
||||
[docs-optional-configuration]: ./config/advanced/optional-config.md
|
||||
[docs::env::sa_env]: ./config/environment.md#spamassassin
|
||||
[docs::env::sa_kill]: ./config/environment.md#sa_kill
|
||||
[github-comment-baredomain]: https://github.com/docker-mailserver/docker-mailserver/issues/3048#issuecomment-1432358353
|
||||
[github-comment-override-hostname]: https://github.com/docker-mailserver/docker-mailserver/issues/1731#issuecomment-753968425
|
||||
[github-issue-95]: https://github.com/docker-mailserver/docker-mailserver/issues/95
|
||||
|
|
@ -542,4 +511,3 @@ $spam_quarantine_to = "amavis\@example.com";
|
|||
[github-issue-1792]: https://github.com/docker-mailserver/docker-mailserver/pull/1792
|
||||
[hanscees-userpatches]: https://github.com/hanscees/dockerscripts/blob/master/scripts/tomav-user-patches.sh
|
||||
[mail-state-folders]: https://github.com/docker-mailserver/docker-mailserver/blob/c7e498194546416fb7231cb03254e77e085d18df/target/scripts/startup/misc-stack.sh#L24-L33
|
||||
[docs-optional-configuration]: ./config/advanced/optional-config.md
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ This documentation provides you not only with the basic setup and configuration
|
|||
|
||||
## About
|
||||
|
||||
`docker-mailserver`, or DMS for short, is a production-ready fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.). It employs only configuration files, no SQL database. The image is focused around the slogan "Keep it simple and versioned".
|
||||
`docker-mailserver`, or DMS for short, is a production-ready fullstack but simple mail server (SMTP, IMAP, LDAP, Anti-spam, Anti-virus, etc.). It employs only configuration files, no SQL database. The image is focused around the slogan "Keep it simple and versioned".
|
||||
|
||||
## Contents
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Site specific:
|
||||
site_name: 'Docker Mailserver'
|
||||
site_description: 'A fullstack but simple mail-server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.) using Docker.'
|
||||
site_description: 'A fullstack but simple mail-server (SMTP, IMAP, LDAP, Anti-spam, Anti-virus, etc.) using Docker.'
|
||||
site_author: 'docker-mailserver (Github Organization)'
|
||||
copyright: '<p>© <a href="https://github.com/docker-mailserver"><em>Docker Mailserver Organization</em></a><br/><span>This project is licensed under the MIT license.</span></p>'
|
||||
|
||||
|
|
|
|||
|
|
@ -368,9 +368,6 @@ DOVECOT_INET_PROTOCOLS=all
|
|||
|
||||
ENABLE_SPAMASSASSIN=0
|
||||
|
||||
# deliver spam messages in the inbox (eventually tagged using SA_SPAM_SUBJECT)
|
||||
SPAMASSASSIN_SPAM_TO_INBOX=1
|
||||
|
||||
# KAM is a 3rd party SpamAssassin ruleset, provided by the McGrail Foundation.
|
||||
# If SpamAssassin is enabled, KAM can be used in addition to the default ruleset.
|
||||
# - **0** => KAM disabled
|
||||
|
|
@ -379,23 +376,26 @@ SPAMASSASSIN_SPAM_TO_INBOX=1
|
|||
# Note: only has an effect if `ENABLE_SPAMASSASSIN=1`
|
||||
ENABLE_SPAMASSASSIN_KAM=0
|
||||
|
||||
# deliver spam messages to the inbox (tagged using SA_SPAM_SUBJECT)
|
||||
SPAMASSASSIN_SPAM_TO_INBOX=1
|
||||
|
||||
# spam messages will be moved in the Junk folder (SPAMASSASSIN_SPAM_TO_INBOX=1 required)
|
||||
MOVE_SPAM_TO_JUNK=1
|
||||
|
||||
# spam messages wil be marked as read
|
||||
MARK_SPAM_AS_READ=0
|
||||
|
||||
# add spam info headers if at, or above that level:
|
||||
# add 'spam info' headers at, or above this level
|
||||
SA_TAG=2.0
|
||||
|
||||
# add 'spam detected' headers at that level
|
||||
# add 'spam detected' headers at, or above this level
|
||||
SA_TAG2=6.31
|
||||
|
||||
# triggers spam evasive actions
|
||||
SA_KILL=10.0
|
||||
|
||||
# add tag to subject if spam detected
|
||||
SA_SPAM_SUBJECT=***SPAM*****
|
||||
SA_SPAM_SUBJECT='***SPAM*** '
|
||||
|
||||
# -----------------------------------------------
|
||||
# --- Fetchmail Section -------------------------
|
||||
|
|
|
|||
|
|
@ -111,7 +111,7 @@ function __setup__security__spamassassin() {
|
|||
|
||||
if [[ ${SPAMASSASSIN_SPAM_TO_INBOX} -eq 1 ]]; then
|
||||
_log 'trace' 'Configuring Spamassassin/Amavis to send SPAM to inbox'
|
||||
_log 'debug' 'SPAM_TO_INBOX=1 is set. SA_KILL will be ignored.'
|
||||
_log 'debug' "'SPAMASSASSIN_SPAM_TO_INBOX=1' is set. The 'SA_KILL' ENV will be ignored."
|
||||
|
||||
sed -i "s|\$final_spam_destiny.*=.*$|\$final_spam_destiny = D_PASS;|g" /etc/amavis/conf.d/49-docker-mailserver
|
||||
sed -i "s|\$final_bad_header_destiny.*=.*$|\$final_bad_header_destiny = D_PASS;|g" /etc/amavis/conf.d/49-docker-mailserver
|
||||
|
|
@ -265,7 +265,7 @@ EOF
|
|||
chown dovecot:root /usr/lib/dovecot/sieve-global/after/spam_to_junk.{sieve,svbin}
|
||||
|
||||
if [[ ${ENABLE_SPAMASSASSIN} -eq 1 ]] && [[ ${SPAMASSASSIN_SPAM_TO_INBOX} -eq 0 ]]; then
|
||||
_log 'warning' "'SPAMASSASSIN_SPAM_TO_INBOX=0' but it is required to be 1 for 'MOVE_SPAM_TO_JUNK=1' to work"
|
||||
_log 'warn' "'SPAMASSASSIN_SPAM_TO_INBOX=0' but it is required to be 1 for 'MOVE_SPAM_TO_JUNK=1' to work"
|
||||
fi
|
||||
else
|
||||
_log 'debug' 'Spam emails will not be moved to the Junk folder'
|
||||
|
|
@ -290,7 +290,7 @@ EOF
|
|||
chown dovecot:root /usr/lib/dovecot/sieve-global/after/spam_mark_as_read.{sieve,svbin}
|
||||
|
||||
if [[ ${ENABLE_SPAMASSASSIN} -eq 1 ]] && [[ ${SPAMASSASSIN_SPAM_TO_INBOX} -eq 0 ]]; then
|
||||
_log 'warning' "'SPAMASSASSIN_SPAM_TO_INBOX=0' but it is required to be 1 for 'MARK_SPAM_AS_READ=1' to work"
|
||||
_log 'warn' "'SPAMASSASSIN_SPAM_TO_INBOX=0' but it is required to be 1 for 'MARK_SPAM_AS_READ=1' to work"
|
||||
fi
|
||||
else
|
||||
_log 'debug' 'Spam emails will not be marked as read'
|
||||
|
|
|
|||
Loading…
Reference in a new issue