Require explicit VERSION in docker-compose files

This commit is contained in:
Kris Lamoureux 2024-10-13 21:31:15 -04:00
parent d62bd06b37
commit 0220de3650
Signed by: kris
GPG Key ID: 3EDA9C3441EDA925
3 changed files with 13 additions and 4 deletions

View File

@ -6,7 +6,9 @@ Encrypt. While similar, the docker-compose files available here cater to
different use cases for deploying Traefik.
## Add services to Traefik
1. Define the external traefik network on the top-level networks key
```
networks:
traefik:
@ -14,12 +16,14 @@ networks:
```
2. Attach your web container to Traefik's network via the service-level `networks` key
```
networks:
- traefik
```
3. Define routing for Traefik in labels, replacing "examplerouter" with something unique
```
labels:
traefik.http.routers.examplerouter.rule: Host(`www.example.org`)
@ -30,30 +34,35 @@ networks:
```
## Variables
Here's a brief explanation of the variables used in the docker-compose files:
### Docker Settings
- `IMAGE`: The name of the Docker image (default: `traefik`).
- `VERSION`: The tag of the Docker image (default: `latest`).
- `VERSION`: The tag of the Docker image (required, no default).
- `NAME`: The name assigned to the created container (default: `traefik`).
### Traefik Settings
- `DASHBOARD`: Enable(=true) or disable(=false) the Traefik API dashboard (default: `false`).
- `DOMAIN`: The domain name where Traefik's dashboard is accessible (default: `traefik.local.krislamo.org`).
- `ENTRYPOINT`: The entry point for the dashboard (default: `local`).
- `EXPOSED_BY_DEFAULT`: Expose Docker containers by default without needing specific labels (default: `false`).
### Network Settings
- `NETWORK`: The Docker network to be used (default: `traefik`).
- `WEB_PORT`: Binding for the regular HTTP traffic (defaults vary).
- `WEBSECURE_PORT`: Binding for HTTPS traffic (default: `0.0.0.0:443:443`, only on HTTPS version).
- `LOCAL_PORT`: Binding for local HTTPS traffic (default: `127.0.0.1:8443:8443`).
### Other Settings
- `LOG_LEVEL`: Logging level (default: `ERROR`).
- `DEBUG`: Enable(=true) or turn off(=false) API debugging (default: `false`).
## License
This project is released under the 0BSD license, which allows for unrestricted
use, modification, and distribution.

View File

@ -7,7 +7,7 @@ networks:
services:
traefik:
image: "${IMAGE:-traefik}:${VERSION:-latest}"
image: "${IMAGE:-traefik}:${VERSION:?}"
container_name: "${NAME:-traefik}"
command:
- --providers.docker=true

View File

@ -7,7 +7,7 @@ networks:
services:
traefik:
image: "${IMAGE:-traefik}:${VERSION:-latest}"
image: "${IMAGE:-traefik}:${VERSION:?}"
container_name: "${NAME:-traefik}"
command:
- --providers.docker=true