You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by kl...@apache.org on 2015/12/19 17:37:14 UTC
[2/2] couchdb-docker git commit: 2.0: more readme tweaks
2.0: more readme tweaks
Project: http://git-wip-us.apache.org/repos/asf/couchdb-docker/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-docker/commit/9270c889
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-docker/tree/9270c889
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-docker/diff/9270c889
Branch: refs/heads/master
Commit: 9270c889466b83ebd58e2f60476483a7d1a3cb32
Parents: 34d52bd
Author: klaemo <kl...@fastmail.fm>
Authored: Sat Dec 19 17:28:21 2015 +0100
Committer: klaemo <kl...@fastmail.fm>
Committed: Sat Dec 19 17:28:21 2015 +0100
----------------------------------------------------------------------
README.md | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb-docker/blob/9270c889/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 4690baa..373d6c5 100644
--- a/README.md
+++ b/README.md
@@ -78,8 +78,21 @@ Time to hack! ...
```bash
docker run -it klaemo/couchdb:2.0-dev --admin=foo:bar
```
-**Note:** This will overwrite the default `--with-haproxy` flag. So, you have to specify it
-explicitly if you wish to use haproxy.
+**Note:** This will overwrite the default `--with-haproxy` flag. The cluster **won't** be exposed on
+port `5984` anymore. The individual nodes listen on `15984`, `25984`, ...`x5984`. If you wish to expose
+the cluster on `5984`, pass `--with-haproxy` explicitly.
+
+Examples:
+```bash
+# display the available options of the couchdb startup script
+docker run --rm klaemo/couchdb:2.0-dev --help
+
+# Enable admin party 🎉 and expose the cluster on port 5984
+docker run -it -p 5984:5984 klaemo/couchdb:2.0-dev --with-admin-party-please --with-haproxy
+
+# Start two nodes (without proxy) exposed on port 15984 and 25984
+docker run -it -p 15984:15984 -p 25984:25984 klaemo/couchdb:2.0-dev -n 2
+```
## Build your own