Documented container-startup behaviour regarding configuration files, and behaviour with environment variables

This commit is contained in:
jreichmann 2017-12-01 11:29:31 +01:00
parent ee8e15944f
commit 52883558b5

View file

@ -1,4 +1,4 @@
#docker-dehydrated
# docker-dehydrated
This is a docker container that wraps around [dehydrated](https://github.com/lukas2511/dehydrated).
@ -6,5 +6,13 @@ This is a docker container that wraps around [dehydrated](https://github.com/luk
The following environment variables can be set to influence the container's behaviour:
- $ENDPOINT which ACME-Endpoint you want to use, supported values: "staging", "production" (default).
- $CHALLENGE what type of challenge should be used, supported values: "http-01" (default), "dns-01"
- `$ENDPOINT` which ACME-Endpoint you want to use, supported values: "staging", "production" (default).
- `$CHALLENGE` what type of challenge should be used, supported values: "http-01" (default), "dns-01"
If the environment variables were not explicitely set, no modification to the configuration file is made
## Behaviour on startup
When the container is started, a script is run which looks for the configuration file in the places supported by dehydrated,
and if no configuration file is found, it will copy the [example configuration file](https://github.com/lukas2511/dehydrated/docs/examples/config)
into `/etc/dehydrated/config`.