From 9db53f20a6d1bffb690db51d026c4d07158ea167 Mon Sep 17 00:00:00 2001 From: remche Date: Mon, 29 Aug 2016 17:03:23 +0200 Subject: [PATCH] Documentation --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 55febab..eff2b5b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # docker-sigal -Docker image based on nginx official one. + +Docker image based on nginx official one for [sigal](http://sigal.saimon.org/en/latest/) gallery. + +Run with : + docker run -p 80:80 -v /path/to/your/pictures/:/pictures --name sigal -d remche/sigal + +default configuration : +- put gallery in /usr/share/nginx/html. You can use a docker volume if you want it permanent : + docker run -p 80:80 -v /path/to/your/pictures/:/pictures -v sigal-html:/usr/share/nginx/html --name sigal -d remche/sigal +- use the galleria theme ; +- keep original, and symlink to ; + +If you want to override this, you can use your own sigal.conf.py : + docker run -p 80:80 -v /path/to/your/pictures/:/pictures -v/path/to/your/sigal.conf.py:/opt/sigal.conf.py --name sigal -d remche/sigal + +You can set a basic authentication in htpasswd format setting HTPASSWD env variable : + docker run -p 80:80 -v /path/to/your/pictures/:/pictures -e HTPASSWD='foo:$apr1$odHl5EJN$KbxMfo86Qdve2FH4owePn.' --name sigal -d remche/sigal +You might then use SSL with [nginx-proxy](https://hub.docker.com/r/jwilder/nginx-proxy/). + +