mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
Improved documentation (added client configuration)
This commit is contained in:
parent
72d10ea14d
commit
1e19ca515e
27
README.md
27
README.md
|
@ -1,6 +1,8 @@
|
||||||
# docker-mailserver
|
# docker-mailserver
|
||||||
|
|
||||||
A fullstack but simple mail server (smtp, imap, antispam, antivirus...)
|
A fullstack but simple mail server (smtp, imap, antispam, antivirus...).
|
||||||
|
Only configuration files, no SQL database. Keep it simple and versioned.
|
||||||
|
Easy to deploy and upgrade.
|
||||||
|
|
||||||
Includes:
|
Includes:
|
||||||
|
|
||||||
|
@ -8,7 +10,7 @@ Includes:
|
||||||
- courier-imap with ssl support
|
- courier-imap with ssl support
|
||||||
- amavis
|
- amavis
|
||||||
- spamassasin
|
- spamassasin
|
||||||
- clamav
|
- clamav with automatic updates
|
||||||
|
|
||||||
Additional informations:
|
Additional informations:
|
||||||
|
|
||||||
|
@ -52,6 +54,25 @@ Additional informations:
|
||||||
- "username1@my-domain.com|alias1,alias2,alias3"
|
- "username1@my-domain.com|alias1,alias2,alias3"
|
||||||
- "username2@my-domain.com|alias4"
|
- "username2@my-domain.com|alias4"
|
||||||
|
|
||||||
|
# usage
|
||||||
|
docker-compose up -d mail
|
||||||
|
|
||||||
|
# client configuration
|
||||||
|
|
||||||
|
# imap
|
||||||
|
username: <username1@my-domain.com>
|
||||||
|
password: <username1password>
|
||||||
|
server: <your-server-ip-or-hostname>
|
||||||
|
imap port: 143 or 993 with ssl (recommended)
|
||||||
|
imap path prefix: INBOX
|
||||||
|
auth method: md5 challenge-response
|
||||||
|
|
||||||
|
# smtp
|
||||||
|
smtp port: 25 or 587 with ssl (recommended)
|
||||||
|
username: <username1@my-domain.com>
|
||||||
|
password: <username1password>
|
||||||
|
auth method: md5 challenge-response
|
||||||
|
|
||||||
# todo
|
# todo
|
||||||
|
|
||||||
Things to do or to improve are stored on [Github](https://github.com/tomav/docker-mailserver/issues), some open by myself.
|
Things to do or to improve are stored on [Github](https://github.com/tomav/docker-mailserver/issues), some open by myself.
|
||||||
|
@ -59,4 +80,4 @@ Feel free to improve this docker image.
|
||||||
|
|
||||||
# wanna help?
|
# wanna help?
|
||||||
|
|
||||||
Fork, improve and PR. ;-)
|
Fork, improve and PR. ;-)
|
||||||
|
|
Loading…
Reference in a new issue