Refacto

.env.dist

@@ -1,9 +1,9 @@
-ACME_DNS_CHALLENGE=false
-ACME_DNS_CHALLENGE_PROVIDER=gandiv5
-[email protected]
-ACME_HTTP_CHALLENGE=false
-ACME_TLS_CHALLENGE=true
-DEFAULT_DOMAIN=my.domain.tld
-HTTP_PORT=80
-HTTPS_PORT=443
-VERSION='v2.11'
+ACME_DNS_CHALLENGE=false            # Activate DNS-01 Challenge
+ACME_DNS_CHALLENGE_PROVIDER=gandiv5 # Use a DNS-01 based challenge provider rather than HTTPs
+[email protected]  # Email address used for ACME registration
+ACME_HTTP_CHALLENGE=false           # Activate HTTP-01 Challenge
+ACME_TLS_CHALLENGE=true             # Activate TLS-ALPN-01 Challenge
+DEFAULT_DOMAIN=my.domain.tld        # Default TLS domains
+HTTP_PORT=80                        # HTTP listen port
+HTTPS_PORT=443                      # HTTPs listen port
+VERSION=v3.1                        # Tag of the Docker image of Traefik

README.md

@@ -42,39 +42,7 @@ docker compose up -d
 
 ## Reference
 
-### Environment variables
-
-#### `ACME_DNS_CHALLENGE`
-
-Activate DNS-01 Challenge. (Default: `false`)
-
-#### `ACME_DNS_CHALLENGE_PROVIDER`
-
-Use a DNS-01 based challenge provider rather than HTTPs.
-
-#### `ACME_EMAIL`
-
-Email address used for ACME registration. (Default: `[email protected]`)
-
-#### `ACME_HTTP_CHALLENGE`
-
-Activate HTTP-01 Challenge. (Default: `false`)
-
-#### `ACME_TLS_CHALLENGE`
-
-Activate TLS-ALPN-01 Challenge. (Default: `true`)
-
-#### `DEFAULT_DOMAIN`
-
-Default TLS domains. (Default: `my.domain.tld`)
-
-#### `HTTP_PORT`
-
-HTTP listen port. (Default: `80`)
-
-#### `HTTPS_PORT`
-
-HTTPs listen port. (Default: `443`)
+See [REFERENCE.md](./REFERENCE.md).
 
 ## Development
 

REFERENCE.md

@@ -0,0 +1,13 @@
+# Reference
+
+| Name                 | Description                                             | Default value             | Enabled |
+| -------------------- | ------------------------------------------------------- | ------------------------- | ------- |
+| ACME_DNS_CHALLENGE   | Activate DNS-01 Challenge                               | `false`                   | true    |
+| ACME_DNS_CHALLENGE_PROVIDER | Use a DNS-01 based challenge provider rather than HTTPs | `gandiv5`          | true    |
+| ACME_EMAIL           | Email address used for ACME registration                | `[email protected]` | true    |
+| ACME_HTTP_CHALLENGE  | Activate HTTP-01 Challenge                              | `false`                   | true    |
+| ACME_TLS_CHALLENGE   | Activate TLS-ALPN-01 Challenge                          | `true`                    | true    |
+| DEFAULT_DOMAIN       | Default TLS domains                                     | `my.domain.tld`           | true    |
+| HTTP_PORT            | HTTP listen port                                        | `80`                      | true    |
+| HTTPS_PORT           | HTTPs listen port                                       | `443`                     | true    |
+| VERSION              | Tag of the Docker image of Traefik                      | `v3.1`                    | true    |

compose.yaml

@@ -1,3 +1,20 @@
+# Copyright (C) 2021-2024 Solution Libre
+# 
+# This file is part of Træfik with Docker Compose.
+# 
+# Træfik with Docker Compose is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Træfik with Docker Compose is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with Træfik with Docker Compose.  If not, see <https://www.gnu.org/licenses/>.
+
 services:
   traefik:
     command: