mirror of
https://github.com/chatmail/relay.git
synced 2026-08-10 18:40:51 +00:00
docs(readme): Reformat README.md (#115)
Fixes: #91 Signed-off-by: Jagoda Ślązak <jslazak@jslazak.com>
This commit is contained in:
Jagoda Estera Ślązak
committed by
GitHub
GitHub
parent
0feb1371b3
commit
2450d1d9c7
+41
-41
@@ -24,22 +24,22 @@ Filtermail in incoming mode performs following steps:
|
||||
|
||||
1. Rejects messages if `DATA` exceeds configured message size limit.
|
||||
2. Rejects messages that do not meet at least one of the following criteria:
|
||||
- PGP encrypted,
|
||||
- securejoin message,
|
||||
- mailer-daemon message,
|
||||
- all recipients allow cleartext
|
||||
(`enforceE2EEincoming` is not present in their mailbox directory).
|
||||
- PGP encrypted,
|
||||
- securejoin message,
|
||||
- mailer-daemon message,
|
||||
- all recipients allow cleartext
|
||||
(`enforceE2EEincoming` is not present in their mailbox directory).
|
||||
3. If `MAIL FROM` doesn't match `From` header,
|
||||
the address is removed from `MAIL FROM` on reinjection
|
||||
(prevents bounces to possibly spoofed `MAIL FROM`).
|
||||
the address is removed from `MAIL FROM` on reinjection
|
||||
(prevents bounces to possibly spoofed `MAIL FROM`).
|
||||
4. Checks message origin,
|
||||
depending on address type:
|
||||
- **domain** - performs a strict DKIM verification and domain alignment check
|
||||
(domain of address from `From` header must exactly match the DKIM signature domain),
|
||||
rejecting messages that fail.
|
||||
- **domain-literal (IP address)** - currently no-op.
|
||||
depending on address type:
|
||||
- **domain** - performs a strict DKIM verification and domain alignment check
|
||||
(domain of address from `From` header must exactly match the DKIM signature domain),
|
||||
rejecting messages that fail.
|
||||
- **domain-literal (IP address)** - currently no-op.
|
||||
5. In case of a DKIM failure,
|
||||
the message is saved to `/tmp/filtermail-rejected/dkim-verify` directory for later inspection.
|
||||
the message is saved to `/tmp/filtermail-rejected/dkim-verify` directory for later inspection.
|
||||
|
||||
### Outgoing mode
|
||||
|
||||
@@ -49,11 +49,11 @@ Filtermail in outgoing mode performs following steps:
|
||||
2. Rejects messages if `DATA` exceeds configured message size limit.
|
||||
3. Rejects messages which `From` header address does not match one in `MAIL FROM`.
|
||||
4. Rejects messages that do not meet at least one of the following criteria:
|
||||
- PGP encrypted,
|
||||
- securejoin message,
|
||||
- sender is in `passthrough_senders`,
|
||||
- self-sent Autocrypt Setup Message,
|
||||
- all recipients match `passthrough_recipients`.
|
||||
- PGP encrypted,
|
||||
- securejoin message,
|
||||
- sender is in `passthrough_senders`,
|
||||
- self-sent Autocrypt Setup Message,
|
||||
- all recipients match `passthrough_recipients`.
|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -63,48 +63,48 @@ Filtermail shares the same configuration file as chatmail relay,
|
||||
but implements a custom parser that only requires a small subset of configuration options:
|
||||
|
||||
- `filtermail_smtp_port` - port to listen on in outgoing mode,
|
||||
defaults to `10080`.
|
||||
defaults to `10080`.
|
||||
- `filtermail_smtp_port_incoming` - port to listen on in incoming mode,
|
||||
defaults to `10081`.
|
||||
defaults to `10081`.
|
||||
- `postfix_reinject_port` - port to reinject messages to postfix in outgoing mode,
|
||||
defaults to `10025`.
|
||||
defaults to `10025`.
|
||||
- `postfix_reinject_port_incoming` - port to reinject messages to postfix in incoming mode,
|
||||
defaults to `10026`.
|
||||
defaults to `10026`.
|
||||
- `max_message_size` - maximum allowed message size in bytes,
|
||||
defaults to `31457280` (30 MiB).
|
||||
defaults to `31457280` (30 MiB).
|
||||
- `max_user_send_per_minute` - email sending rate per user and minute,
|
||||
defaults to `60`.
|
||||
defaults to `60`.
|
||||
- `max_user_send_burst_size` - per-user max burst size for sending rate limiting (GCRA bucket capacity),
|
||||
defaults to `10`.
|
||||
defaults to `10`.
|
||||
- `passthrough_senders` - space separated list of email addresses
|
||||
which can send outbound un-encrypted mail.
|
||||
which can send outbound un-encrypted mail.
|
||||
- `passthrough_recipients` - space separated list of email addresses
|
||||
which can receive inbound un-encrypted mail,
|
||||
item may start with `@` to whitelist whole recipient domains.
|
||||
which can receive inbound un-encrypted mail,
|
||||
item may start with `@` to whitelist whole recipient domains.
|
||||
- `mail_domain` - domain name used in email addresses.
|
||||
- `mailboxes_dir` - path to mailboxes directory,
|
||||
defaults to `/home/vmail/mail/<mail_domain>`.
|
||||
defaults to `/home/vmail/mail/<mail_domain>`.
|
||||
|
||||
The following options are Filtermail-specific,
|
||||
they are not read by other chatmail relay components
|
||||
and usually do not need to be set at all:
|
||||
|
||||
- `filtermail_host` - IP address to listen on,
|
||||
defaults to `127.0.0.1`.
|
||||
defaults to `127.0.0.1`.
|
||||
- `postfix_host` - hostname or IP address where postfix is set up,
|
||||
a host is resolved only on Filtermail startup,
|
||||
useful in case MTA runs somewhere outside of localhost,
|
||||
defaults to `127.0.0.1`.
|
||||
a host is resolved only on Filtermail startup,
|
||||
useful in case MTA runs somewhere outside of localhost,
|
||||
defaults to `127.0.0.1`.
|
||||
|
||||
### Environment variables
|
||||
|
||||
Additional options that can be set using environment variables:
|
||||
|
||||
- `RUST_LOG` - set log level,
|
||||
defaults to `info`.
|
||||
defaults to `info`.
|
||||
- `FILTERMAIL_SKIP_DKIM` - completely skip DKIM verification;
|
||||
only for testing purposes and not recommended for production use,
|
||||
defaults to `0`.
|
||||
only for testing purposes and not recommended for production use,
|
||||
defaults to `0`.
|
||||
|
||||
## Usage outside of chatmail relay
|
||||
|
||||
@@ -113,11 +113,11 @@ Although unsupported, it may still work outside of this context or even without
|
||||
with few considerations:
|
||||
|
||||
- Filtermail expects to receive messages from a trusted server,
|
||||
and thus should not be exposed directly to the internet.
|
||||
and thus should not be exposed directly to the internet.
|
||||
- Issues outside of chatmail relay context are not necessarily considered bugs;
|
||||
PRs fixing them are not guaranteed to be accepted.
|
||||
(Trivial changes may still be considered,
|
||||
please open an issue to discuss any such changes before working on them).
|
||||
PRs fixing them are not guaranteed to be accepted.
|
||||
(Trivial changes may still be considered,
|
||||
please open an issue to discuss any such changes before working on them).
|
||||
|
||||
|
||||
## Releases
|
||||
@@ -131,5 +131,5 @@ Binaries are available on the [releases page](https://github.com/chatmail/filter
|
||||
|
||||
Code licensed under [MIT](LICENSE).
|
||||
|
||||
Binary releases of `filtermail` link with `viadkim`
|
||||
Binary releases of `filtermail` link with `viadkim`
|
||||
and are thus subject to the [GPL-3.0-or-later](LICENSE-GPL).
|
||||
|
||||
Reference in New Issue
Block a user