container/dovecot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
[skip build]
This commit is contained in:
Sebastian Hugentobler 2016-10-31 10:28:08 +00:00
parent 8ef3298477
commit dafc2665fb
1 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -2,126 +2,126 @@
Uses [SSMTP](https://packages.debian.org/stable/mail/ssmtp) to send mails (for example if you have a redirect sieve rule). Uses [SSMTP](https://packages.debian.org/stable/mail/ssmtp) to send mails (for example if you have a redirect sieve rule).
## Volumes # Volumes
- `/var/lib/vmail/mail` - `/var/lib/vmail/mail`
- `/etc/ssl/mail:ro`: certificates have to be here. - `/etc/ssl/mail:ro`: certificates have to be here.
## Environment Variables # Environment Variables
### HOSTNAME ## HOSTNAME
Fully qualified name of the mail host. Fully qualified name of the mail host.
### SSMTP_MAIL_RELAY ## SSMTP_MAIL_RELAY
Hostname and port for the used smtp relay (for example `mail.example.com:587`). Hostname and port for the used smtp relay (for example `mail.example.com:587`).
### SSMTP_USER ## SSMTP_USER
User to authenticate agains the smtp relay. User to authenticate agains the smtp relay.
### SSMTP_PASSWORD ## SSMTP_PASSWORD
Password to authenticate agains the smtp relay. Password to authenticate agains the smtp relay.
### SSMTP_AUTH_METHOD ## SSMTP_AUTH_METHOD
- default: LOGIN - default: LOGIN
Which authentication mechanism to use for the smtp relay. Which authentication mechanism to use for the smtp relay.
### SSMTP_USE_STARTTLS ## SSMTP_USE_STARTTLS
- default: yes - default: yes
Whether to use starttls for the smtp relay. Whether to use starttls for the smtp relay.
### LDAP_URI ## LDAP_URI
Complete uri for the authentication ldap host. Complete uri for the authentication ldap host.
### LDAP_SIEVE_HOST ## LDAP_SIEVE_HOST
Has to be the same as `LDAP_URI` but in a different format (like `ldap:389`). Has to be the same as `LDAP_URI` but in a different format (like `ldap:389`).
### LDAP_BIND_DN ## LDAP_BIND_DN
DN used to authenticate against ldap. DN used to authenticate against ldap.
### LDAP_BIND_PASSWORD ## LDAP_BIND_PASSWORD
Password used to authenticate against ldap. Password used to authenticate against ldap.
### LDAP_BASE_DN ## LDAP_BASE_DN
Base DN to look for users on the ldap host. Base DN to look for users on the ldap host.
### LDAP_SCOPE ## LDAP_SCOPE
- default: subtree - default: subtree
Search scope of ldap queries. Search scope of ldap queries.
### LDAP_PASS_FILTER ## LDAP_PASS_FILTER
Specifies the filter on how user is found on the ldap host. Specifies the filter on how user is found on the ldap host.
[Dovecot variables](http://wiki2.dovecot.org/Variables) can be used. [Dovecot variables](http://wiki2.dovecot.org/Variables) can be used.
### LDAP_USER_ATTRIBUTE ## LDAP_USER_ATTRIBUTE
- default: cn - default: cn
The ldap attribute which stands for the username. The ldap attribute which stands for the username.
### LDAP_PASSWORD_ATTRIBUTE ## LDAP_PASSWORD_ATTRIBUTE
- default: userPassword - default: userPassword
The ldap attribute which stands for the password. The ldap attribute which stands for the password.
### LDAP_SIEVE_ATTRIBUTE ## LDAP_SIEVE_ATTRIBUTE
- default: sieve - default: sieve
The ldap attribute which contains the sieve rules. The ldap attribute which contains the sieve rules.
### LDAP_USE_TLS ## LDAP_USE_TLS
- default: yes - default: yes
Whether to use tls when connecting to the ldap host. Whether to use tls when connecting to the ldap host.
### LDAP_DEFAULT_PASSSCHEME ## LDAP_DEFAULT_PASSSCHEME
- default: SSHA - default: SSHA
Default password scheme used on the ldap host. Default password scheme used on the ldap host.
### ALLOWED_USERNAME_CHARS ## ALLOWED_USERNAME_CHARS
- default: äöüabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@ - default: äöüabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@
List of characters allowed in a username. List of characters allowed in a username.
### AUTH_MECHANISMS ## AUTH_MECHANISMS
- default: plain login - default: plain login
Space seperated list of supported [authentication mechanisms](http://wiki2.dovecot.org/Authentication/Mechanisms). Space seperated list of supported [authentication mechanisms](http://wiki2.dovecot.org/Authentication/Mechanisms).
### CERTNAME ## CERT_NAME
- default: fullchain.pem - default: fullchain.pem
Name of the certificate file. Name of the certificate file.
### Keyname ## KEY_NAME
- default: privkey.pem - default: privkey.pem
Name of the key file. Name of the key file.
### SSL_DH_LENGTH ## SSL_DH_LENGTH
- default: 2048 - default: 2048
Length of the Diffie-Helman key in bits. Length of the Diffie-Helman key in bits.
### SSL_PROTOCOLS ## SSL_PROTOCOLS
- default: !SSLv2 !SSLv3 - default: !SSLv2 !SSLv3
Space seperated list of allowed ssl protocols (`!`disables a protocol). Space seperated list of allowed ssl protocols (`!`disables a protocol).
### SSL_CIPHERLIST ## SSL_CIPHERLIST
- default: ALL:!ADH:!LOW:!SSLv2:!EXP:!aNULL:!RC4:+HIGH:+MEDIUM - default: ALL:!ADH:!LOW:!SSLv2:!EXP:!aNULL:!RC4:+HIGH:+MEDIUM
Colon seperated list of supported ciphers (`!`disables a cipher). Colon seperated list of supported ciphers (`!`disables a cipher).
### IMAP_MAX_USER_CONNECTIONS ## IMAP_MAX_USER_CONNECTIONS
- default: 10 - default: 10
Maximum number of connections from the same user + ip. Maximum number of connections from the same user + ip.
## Ports # Ports
- 143 - 143
## Capabilities # Capabilities
- CHOWN - CHOWN
- DAC_OVERRIDE - DAC_OVERRIDE
- FOWNER - FOWNER