From 6bba15bbd7c41efa1791d8b99604e670b426fac4 Mon Sep 17 00:00:00 2001 From: valvin Date: Sat, 20 Feb 2021 21:54:07 +0100 Subject: [PATCH] docs(readme): update and fix typo --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eb67e85..cbe31d3 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ This image allowes to publish static content locate in a git repository on Gemin This images takes these environment variables: -| --- | --- | --- | | variable | description | default value | +| --- | --- | --- | | `GEMINI_DOMAIN` | domain name of the capsule | example.com | | `GEMINI_GIT_REPO` | url of the git repository containing content | `https://gitlab.com/valvin/gemini-agate-image` | -| `GEMINI_CONTENT_FOLDER` | folder inside the git repository which contains the content | `content`| +| `GEMINI_CONTENT_FOLDER` | folder inside the git repository which contains the content. it means you have `content` folder in your repo with default | `content`| | `GEMINI_GIT_PATH` | path in which git repository will be cloned | `/app/data` | | `GEMINI_CERT_PATH` | path which contains certificates. this path has to be a volume if not new certs will be generated | `/certs` | | `GEMINI_LANG` | langage of the content | `fr-FR` | @@ -22,3 +22,12 @@ initialization process is: * check if cert are present in `GEMINI_CERT_PATH` if not it creates it * clone or update the content repository * launch agate + +docker command example: + +``` +docker run --rm -it -e GEMINI_DOMAIN=mydomain.tld \ + -e GEMINI_GIT_REPO=https://gitlab.com/valvin/gemini-agate-image \ + -v $(pwd)/certs:/certs -p 1965:1965 + registry.gitlab.com/valvin/gemini-agate-image:latest +```