From 1e19ca515e8d4ce128c2d4242fbed5d6772fa413 Mon Sep 17 00:00:00 2001 From: Thomas VIAL Date: Mon, 29 Jun 2015 14:55:54 +0200 Subject: [PATCH] Improved documentation (added client configuration) --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c64066c9..d3b584b6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # 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: @@ -8,7 +10,7 @@ Includes: - courier-imap with ssl support - amavis - spamassasin -- clamav +- clamav with automatic updates Additional informations: @@ -52,6 +54,25 @@ Additional informations: - "username1@my-domain.com|alias1,alias2,alias3" - "username2@my-domain.com|alias4" + # usage + docker-compose up -d mail + +# client configuration + + # imap + username: + password: + server: + 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: + password: + auth method: md5 challenge-response + # todo 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? -Fork, improve and PR. ;-) \ No newline at end of file +Fork, improve and PR. ;-)