Linked Zero-Config-Tutorial in README, improved wording a bit on the tutorial

This commit is contained in:
jreichmann 2017-12-06 08:32:35 +01:00
parent 52e7c7b506
commit db56dde142
2 changed files with 13 additions and 3 deletions

View file

@ -2,6 +2,11 @@
This is a docker container that wraps around [dehydrated](https://github.com/lukas2511/dehydrated). This is a docker container that wraps around [dehydrated](https://github.com/lukas2511/dehydrated).
## Usage
For a short tutorial on how to use this container with zero-configuration to sign certificates
using the HTTP-Challenge, see [zero-config-mode.md]("Zero-Config"-Mode).
## Environment variables ## Environment variables
The following environment variables can be set to influence the container's behaviour: The following environment variables can be set to influence the container's behaviour:
@ -16,3 +21,4 @@ If the environment variables were not explicitely set, no modification to the co
When the container is started, a script is run which looks for the configuration file in the places supported by dehydrated, 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) 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`. into `/etc/dehydrated/config`.

View file

@ -13,7 +13,7 @@ for creating certificates using the HTTP-Challenge:
Now create a folder in which dehydrated can push the challenge-data later, in this tutorial it Now create a folder in which dehydrated can push the challenge-data later, in this tutorial it
will be called ``dehydrated-www``. Configure your Webserver to serve the contents of this folder will be called ``dehydrated-www``. Configure your Webserver to serve the contents of this folder
under ``domain``/.well-known/ (for all domains which you want to create certificates for). under ``domain``/.well-known/ (for all domains for which you want to create certificates).
Next create another folder in which dehydrated will place its configuration, certificates etc., Next create another folder in which dehydrated will place its configuration, certificates etc.,
in this tutorial it will be called ``dehydrated-data``. In this folder, create a file called in this tutorial it will be called ``dehydrated-data``. In this folder, create a file called
@ -32,11 +32,15 @@ not need to pass environment variables to alter the default behaviour. To run th
execute: execute:
```bash ```bash
$ docker run -v ./dehydrated-www:/var/www/dehydrated -v ./dehydrated-data:/etc/dehydrated jcgruenhage/dehydrated $ docker run -v ./dehydrated-www:/var/www/dehydrated \
-v ./dehydrated-data:/etc/dehydrated jcgruenhage/dehydrated
``` ```
Please note that on SELinux-Systems, you need to set the "SELinux"-Flag when passing volumes: Please note that on SELinux-Systems, you need to set the "SELinux"-Flag when passing volumes:
``./dehydrated-www:/var/www/dehydrated:z`` (analog for ``dehydrated-data``). ``./dehydrated-www:/var/www/dehydrated:z`` (analog for ``dehydrated-data``).
Also, the container will ``chown`` the folders passed to himself, so make sure your webserver can Also, the container will ``chown`` the folders passed to himself, so make sure your webserver can
still server the contents of ``dehydrated-www``. still serve the contents of ``dehydrated-www``.
After the challenges have been run, the certificates will be stored in ``dehydrated-data/certs``,
make sure to back this folder up!