From 787be18e5647a17fbe704624888a4efc5f268992 Mon Sep 17 00:00:00 2001
From: "James Z.M. Gao" <gaozhm@mvad.com>
Date: Tue, 3 May 2016 09:09:47 +0800
Subject: update README.md

---
 README.md | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index dafacc2..88e60b7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,36 @@
 # docker-davmail
-A EWS proxy in docker.
+
+A EWS proxy in docker. Run it like this:
+
+```Bash
+VPN_SERVER=<server-domain-or-ip>
+VPN_USER=<user>
+VPN_PASSWORD=<password>
+VPN_ROUTING_IPS="172.0.0.0/8 www.google.com"
+#VPN_PPP_OPTIONS=
+#VPN_DEBUG=y
+
+```Bash
+docker run --net=host \
+           --name davmail \
+           -e DAVMAIL_URL=<url> \
+           -e DAVMAIL_SERVER_CERTIFICATE_HASH=<optional-certificate-hash>
+           -e DAVMAIL_NTLM_DOMAIN=<optional-windows-domain>
+           -d \
+           gzm55/pptp-client
+```
+
+Accepted docker environment variables:
+
+* DAVMAIL_URL: server domain or ip
+* DAVMAIL_SERVER_CERTIFICATE_HASH: optional, cirtificate hash, like 11:22:...
+* DAVMAIL_NTLM_DOMAIN: optional, windows domain
+* DAVMAIL_CONFIG_URL: a url for downloading a specific configuration, this can override all other options
+
+Listened ports:
+
+* caldav port: 1080
+* imap port:   1143
+* ldap port:   1389
+* pop3 port:   1110
+* smtp port:   1025
-- 
cgit v1.2.3