README: Explain how to use with Docker

1 files changed, 29 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index dc31d9ab..12dad78e 100644
--- a/README.rst
+++ b/README.rst
@@ -180,6 +180,35 @@ Then you can install pgcli:
     $ sudo pip install pgcli
 
 
+Docker
+======
+
+Pgcli can be run from within Docker. This can be useful to try pgcli without
+installing it, or any dependencies, system-wide.
+
+To build the image:
+
+::
+    $ docker build -t pgcli .
+
+To create a container from the image:
+
+::
+    $ docker run --rm -ti pgcli pgcli <ARGS>
+
+To access postgresql databases listening on localhost, make sure to run the
+docker in "host net mode". E.g. to access a database called "foo" on the
+postgresql server running on localhost:5432 (the standard port):
+
+::
+    $ docker run --rm -ti --net host pgcli pgcli -h localhost foo
+
+To connect to a locally running instance over a unix socket, bind the socket to
+the docker container:
+
+::
+    $ docker run --rm -ti -v /var/run/postgres:/var/run/postgres pgcli pgcli foo
+
 Thanks:
 -------