dovecot/README.md

124 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

[Dovecot](http://www.dovecot.org/) with imap, starttls, oauth2 proxy auth and
sieve rules.
2016-10-28 07:22:49 +00:00
Uses [SSMTP](https://packages.debian.org/stable/mail/ssmtp) to send mails (for
example if you have a redirect sieve rule).
2016-10-28 07:22:49 +00:00
Reuses the same database schema as the {postfix container](/container/postfix).
2021-10-05 07:34:51 +00:00
2016-10-31 10:28:08 +00:00
# Volumes
2016-10-28 07:22:49 +00:00
- `/var/lib/vmail/mail`
2016-10-31 10:28:08 +00:00
# Environment Variables
2016-10-31 10:28:08 +00:00
## HOSTNAME
2016-10-28 07:22:49 +00:00
Fully qualified name of the mail host.
2021-08-23 17:31:54 +00:00
## GRANT_URL
2021-08-23 17:31:54 +00:00
OAuth2 url for token grants (password grant type).
## INTROSPECTION_URL
OAuth2 url for token information. Must include client id and client secret in
basic auth format.
## TOKENINFO_URL
OAuth2 url for requestion information about a token. Must include client id and
client secret in basic auth format.
2021-08-23 17:31:54 +00:00
## DB_HOST
2021-11-22 13:42:35 +00:00
Postgre database host.
2021-08-23 17:31:54 +00:00
## DB_USER
2021-08-23 17:31:54 +00:00
User to connect to the database.
2021-08-23 17:31:54 +00:00
## DB_PW
Password to use for the database user.
## DB_NAME
- default: email
Name of the postgre database to connect to.
2021-08-23 17:31:54 +00:00
2016-10-31 10:28:08 +00:00
## SSMTP_MAIL_RELAY
2016-10-28 07:22:49 +00:00
Hostname and port for the used smtp relay (for example `mail.example.com:587`).
2016-10-31 10:28:08 +00:00
## SSMTP_USER
2016-10-28 07:22:49 +00:00
User to authenticate agains the smtp relay.
2016-10-31 10:28:08 +00:00
## SSMTP_PASSWORD
2016-10-28 07:22:49 +00:00
Password to authenticate agains the smtp relay.
2016-10-31 10:28:08 +00:00
## SSMTP_AUTH_METHOD
2016-10-28 07:22:49 +00:00
- default: LOGIN
Which authentication mechanism to use for the smtp relay.
2016-10-31 10:28:08 +00:00
## SSMTP_USE_STARTTLS
2016-10-28 07:22:49 +00:00
- default: yes
Whether to use starttls for the smtp relay.
2016-10-31 10:28:08 +00:00
## ALLOWED_USERNAME_CHARS
- default:
äöüabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@
2016-10-28 07:22:49 +00:00
List of characters allowed in a username.
2016-10-31 10:28:08 +00:00
## AUTH_MECHANISMS
2018-02-27 16:02:32 +00:00
- default: plain
2016-10-28 07:22:49 +00:00
Space seperated list of supported
[authentication mechanisms](http://wiki2.dovecot.org/Authentication/Mechanisms).
2016-10-28 07:22:49 +00:00
2018-02-16 08:33:18 +00:00
## SSL_MIN_PROTOCOL
2019-02-18 12:30:33 +00:00
- default: TLSv1.2
2016-10-28 07:22:49 +00:00
2018-02-16 08:33:18 +00:00
Ssl minimum protocol version.
2016-10-28 07:22:49 +00:00
2016-10-31 10:28:08 +00:00
## SSL_CIPHERLIST
- default:
ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256
2016-10-28 07:22:49 +00:00
Colon seperated list of supported ciphers (`!`disables a cipher).
2018-02-16 08:33:18 +00:00
Go [here](https://www.openssl.org/docs/manmaster/man1/ciphers.html) for a list
of ciphers.
2016-10-31 10:28:08 +00:00
## IMAP_MAX_USER_CONNECTIONS
2016-10-28 07:22:49 +00:00
- default: 10
Maximum number of connections from the same user + ip.
2016-10-31 10:28:08 +00:00
# Ports
2016-10-28 07:22:49 +00:00
- 143
2016-10-31 10:28:08 +00:00
# Capabilities
2016-10-28 07:22:49 +00:00
- CHOWN
- DAC_OVERRIDE
- FOWNER
- NET_BIND_SERVICE
- SETGID
- SETUID
2016-10-28 11:05:52 +00:00
- SYS_CHROOT