Chore/docker-documentation-improvements (#2494)

* unify env_var names to replace

* detail more and improve docker doc

* fix title

* move acme email and domains to traefik command

* add details about TRAEFIK_ACME_* variables

* Fix preview links from /develop to /master

1 files changed, 70 insertions, 18 deletions

diff --git a/support/doc/docker.md b/support/doc/docker.md
index b251329d0..2ee922b87 100644
--- a/support/doc/docker.md
+++ b/support/doc/docker.md
@@ -14,43 +14,95 @@ PeerTube needs a PostgreSQL and a Redis instance to work correctly. If you want
 to quickly set up a full environment, either for trying the service or in
 production, you can use a `docker-compose` setup.
 
+#### Go to your peertube workdir
 ```shell
-$ cd /your/peertube/directory
-$ mkdir ./docker-volume && mkdir ./docker-volume/traefik
-$ curl "https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/config/traefik.toml" > ./docker-volume/traefik/traefik.toml
-$ touch ./docker-volume/traefik/acme.json && chmod 600 ./docker-volume/traefik/acme.json
-$ curl -s "https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml" -o docker-compose.yml "https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/docker/production/.env" -o .env
+cd /your/peertube/directory
 ```
-View the source of the files you're about to download: [docker-compose.yml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/docker-compose.yml) and the [traefik.toml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/config/traefik.toml) and the [.env](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/.env)
 
-Update the reverse proxy configuration:
+#### Create the reverse proxy configuration directory
 
 ```shell
-$ vim ./docker-volume/traefik/traefik.toml
+mkdir -p ./docker-volume/traefik
 ```
 
-Tweak the `docker-compose.yml` file there according to your needs:
+#### Get the latest reverse proxy configuration
 
 ```shell
-$ vim ./docker-compose.yml
+curl https://raw.github.com/chocobozzz/PeerTube/master/support/docker/production/config/traefik.toml > ./docker-volume/traefik/traefik.toml
 ```
 
-Then tweak the `.env` file to change the environment variables:
+View the source of the file you're about to download: [traefik.toml](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/config/traefik.toml)
+
+#### Create Let's Encrypt ACME certificates as JSON file
 
 ```shell
-$ vim ./.env
+touch ./docker-volume/traefik/acme.json
 ```
-If you did not download the .env file above, here you can look at the variables that can be set:
-https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/.env
+Needs to have file mode 600:
+```shell
+chmod 600 ./docker-volume/traefik/acme.json 
+```
+
+#### Get the latest Compose file
+
+```shell
+curl https://raw.github.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml > docker-compose.yml 
+```
+
+View the source of the file you're about to download: [docker-compose.yml](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/docker-compose.yml)
+
+
+#### Get the latest env_file
+
+```shell
+curl https://raw.github.com/Chocobozzz/PeerTube/master/support/docker/production/.env > .env
+```
+
+View the source of the file you're about to download: [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env)
+
+#### Update the reverse proxy configuration
+
+```shell
+vim ./docker-volume/traefik/traefik.toml
+```
+
+~~You must replace `<MY EMAIL ADDRESS>` and `<MY DOMAIN>` to enable Let's Encrypt SSL Certificates creation.~~ Now included in `.env` file with `TRAEFIK_ACME_EMAIL` and `TRAEFIK_ACME_DOMAINS` variables used through traefik service command value of `docker-compose.yml` file.
+
+More at: https://docs.traefik.io/v1.7
+
+#### Tweak the `docker-compose.yml` file there according to your needs
+
+```shell
+vim ./docker-compose.yml
+```
+
+#### Then tweak the `.env` file to change the environment variables
+
+```shell
+vim ./.env
+```
+In the downloaded example [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env), you must replace:
+- `<MY POSTGRES USERNAME>`
+- `<MY POSTGRES PASSWORD>`
+- `<MY POSTGRES DB>`
+- `<MY DOMAIN>` without 'https://'
+- `<MY EMAIL ADDRESS>`
 
 Other environment variables are used in
-`support/docker/production/config/custom-environment-variables.yaml` and can be
+[/support/docker/production/config/custom-environment-variables.yaml](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/config/custom-environment-variables.yaml) and can be
 intuited from usage.
 
-You can use the regular `up` command to set it up:
+#### Testing local Docker setup
+
+To test locally your Docker setup, you must add your domain (`<MY DOMAIN>`) in `/etc/hosts`: 
+```
+127.0.0.1       localhost   mydomain.tld
+```
+
+#### You can use the regular `up` command to set it up
 
 ```shell
-$ docker-compose up
+docker-compose up
 ```
 ### Obtaining Your Automatically Generated Admin Credentials
 Now that you've installed your PeerTube instance you'll want to grep your peertube container's logs for the `root` password.
@@ -88,5 +140,5 @@ $ docker build . -f ./support/docker/production/Dockerfile.buster
 
 ## Development
 
-We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#develop)
+We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md#develop)
 for more information on how you can hack PeerTube!