From: bozdoz <howaboutben+github@gmail.com>
Date: Sat, 5 Jan 2019 23:03:52 +0000 (-0400)
Subject: Add Docker instructions to README
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=930813e0c5061c129326e3f43bb1267067e57cd4;p=postgresql-autodoc

Add Docker instructions to README
---

diff --git a/README.org b/README.org
index 1838fcd..1458a25 100644
--- a/README.org
+++ b/README.org
@@ -30,6 +30,30 @@ Once you have installed the requirements, browse to the autodoc directory and ru
 
 ~$ sudo make install~
 
+*** Docker
+
+Install [Docker](https://www.docker.com/)
+
+Create a Docker Image:
+
+~$ docker build . -t autodoc~
+
+Running Docker:
+
+Create an env file by copying the example file and filling in details:
+
+~$ cp env-example env~
+
+Run a Docker container (with default command in Dockerfile):
+
+~$ docker run --mount src=`pwd`,target=/app,type=bind --network=host --env-file ./env -v $pwd:/app autodoc~
+
+Note: --network=host is for accessing a database on localhost
+
+Run a custom container (see Usage below; if you want the files to appear in current directory, use the `--mount` arg above):
+
+~$ docker run autodoc postgresql_autodoc [options]~
+
 ** Usage
 
   ~postgresql_autodoc [options]~