mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
Updated Configure Accounts (markdown)
This commit is contained in:
Georg Lauterbach
parent
2c496e3d5e
commit
b5c46127ae
|
|
@ -1,61 +1,30 @@
|
|||
## Adding a new account
|
||||
|
||||
Users (email accounts) are managed in `/tmp/docker-mailserver/postfix-accounts.cf`.
|
||||
|
||||
The best way to manage accounts is to use the reliable [setup.sh](https://github.com/docker-mailserver/docker-mailserver/wiki/Setup-docker-mailserver-using-the-script-setup.sh) script.
|
||||
|
||||
Or you may directly add the _full_ email address and its encrypted password, separated by a pipe.
|
||||
|
||||
Example:
|
||||
Users (email accounts) are managed in `/tmp/docker-mailserver/postfix-accounts.cf`. **_The best way to manage accounts is to use the reliable [setup.sh](https://github.com/docker-mailserver/docker-mailserver/wiki/Setup-docker-mailserver-using-the-script-setup.sh) script_**. Or you may directly add the _full_ email address and its encrypted password, separated by a pipe:
|
||||
|
||||
``` INI
|
||||
user1@domain.tld|{SHA512-CRYPT}$6$2YpW1nYtPBs2yLYS$z.5PGH1OEzsHHNhl3gJrc3D.YMZkvKw/vp.r5WIiwya6z7P/CQ9GDEJDr2G2V0cAfjDFeAQPUoopsuWPXLk3u1
|
||||
user2@otherdomain.tld|{SHA512-CRYPT}$6$2YpW1nYtPBs2yLYS$z.5PGH1OEzsHHNhl3gJrc3D.YMZkvKw/vp.r5WIiwya6z7P/CQ9GDEJDr2G2V0cAfjDFeAQPUoopsuWPXLk3u1
|
||||
````
|
||||
|
||||
In the example above, we've added 2 mail accounts for 2 different domains. Consequently, the mail-server will automagically be configured as multi-domains.
|
||||
|
||||
Therefore, to _generate_ a new mail account data, directly from your docker host, you could for example run the following:
|
||||
In the example above, we've added 2 mail accounts for 2 different domains. Consequently, the mail server will automatically be configured for multi-domains. Therefore, to generate a new mail account data, directly from your docker host, you could for example run the following:
|
||||
|
||||
``` BASH
|
||||
docker run --rm \
|
||||
-e MAIL_USER=user1@domain.tld \
|
||||
-e MAIL_PASS=mypassword \
|
||||
-ti tvial/docker-mailserver:latest \
|
||||
-ti mailserver/docker-mailserver:latest \
|
||||
/bin/sh -c 'echo "$MAIL_USER|$(doveadm pw -s SHA512-CRYPT -u $MAIL_USER -p $MAIL_PASS)"' >> config/postfix-accounts.cf
|
||||
|
||||
You will then be asked for a password, and be given back the data for a new account entry, as text.
|
||||
|
||||
To actually _add_ this new account, just copy all the output text in `config/postfix-accounts.cf` file of your running container.
|
||||
|
||||
Please note the `doveadm pw` command lets you choose between several encryption schemes for the password. Use doveadm pw -l to get a list of the currently supported encryption schemes.
|
||||
|
||||
> Note: changes to the accounts list require a restart of the container, using `supervisord`. See [#552](../issues/552)
|
||||
|
||||
***
|
||||
## Mailbox quota
|
||||
|
||||
On top of the default quota (`POSTFIX_MAILBOX_SIZE_LIMIT`), you can define specific quotas per mailbox.
|
||||
Quota implementation relies on [dovecot quota](https://wiki.dovecot.org/Quota/Configuration) which requires dovecot to be enabled. Consequently, quota directives are disabled when `SMTP_ONLY=1` or when `ENABLE_LDAP=1` or when explicitly disabled with `ENABLE_QUOTAS=0`.
|
||||
<br>
|
||||
|
||||
|
||||
A warning message will be sent to the user when his mailbox is reaching quota limit. Have a look at [90-quota.cf](https://github.com/docker-mailserver/docker-mailserver/tree/master/target/dovecot/90-quota.conf) for further details.
|
||||
|
||||
### Commands
|
||||
_exec in the container_
|
||||
|
||||
- `setquota <user@domain.tld> [<quota>]`: define the quota of a mailbox (quota format e.g. 302M (B (byte), k (kilobyte), M (megabyte), G (gigabyte) or T (terabyte)))
|
||||
- `delquota <user@domain.tld>`: delete the quota of a mailbox
|
||||
- `doveadm quota get -u <user@domain>`: display the quota and the statistics of a mailbox
|
||||
|
||||
### `dovecot-quotas.cf`
|
||||
|
||||
This file is a key-value database where quotas are stored.
|
||||
|
||||
_dovecot-quotas.cf_
|
||||
```
|
||||
user@domain.tld:50M
|
||||
john@other-domain.tld:1G
|
||||
```
|
||||
|
||||
You will then be asked for a password, and be given back the data for a new account entry, as text. To actually _add_ this new account, just copy all the output text in `config/postfix-accounts.cf` file of your running container. Please note the `doveadm pw` command lets you choose between several encryption schemes for the password. Use doveadm pw -l to get a list of the currently supported encryption schemes.
|
||||
|
||||
**Note**: Changes to the accounts list require a restart of the container, using `supervisord`. See [#552](https://github.com/docker-mailserver/docker-mailserver/issues/552).
|
||||
|
||||
---
|
||||
|
||||
### Notes
|
||||
- *imap-quota* is enabled and allow clients to query their mailbox usage.
|
||||
|
||||
- `imap-quota` is enabled and allow clients to query their mailbox usage.
|
||||
- When the mailbox is deleted, the quota directive is deleted as well.
|
||||
- LDAP ? Dovecot quotas supports LDAP **but it's not implemented** (_PR are welcome!_).
|
||||
- Dovecot quotas support LDAP, **but it's not implemented** (_PR are welcome!_).
|
||||
Loading…
Reference in a new issue