]> granicus.if.org Git - postgresql-autodoc/commitdiff
Add Docker instructions to README
authorbozdoz <howaboutben+github@gmail.com>
Sat, 5 Jan 2019 23:03:52 +0000 (19:03 -0400)
committerGitHub <noreply@github.com>
Sat, 5 Jan 2019 23:03:52 +0000 (19:03 -0400)
README.org

index 1838fcd61d2fcc505582287c3da240768193c8e0..1458a25911ef52a5bca2102ed3b7ecf4afc6cd94 100644 (file)
@@ -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]~