valvin
/
gemini-agate-image
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

docs(readme): update and fix typo

This commit is contained in:
valvin 2021-02-20 21:54:07 +01:00
parent 470f8aa8ea
commit 6bba15bbd7
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -4,11 +4,11 @@ This image allowes to publish static content locate in a git repository on Gemin
This images takes these environment variables: This images takes these environment variables:
| --- | --- | --- |
| variable | description | default value | | variable | description | default value |
| --- | --- | --- |
| `GEMINI_DOMAIN` | domain name of the capsule | example.com | | `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_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_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_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` | | `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 * check if cert are present in `GEMINI_CERT_PATH` if not it creates it
* clone or update the content repository * clone or update the content repository
* launch agate * 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
```