diff --git a/docs/02-setup/05-overrides.md b/docs/02-setup/05-overrides.md index f1e274b1..805f43b2 100644 --- a/docs/02-setup/05-overrides.md +++ b/docs/02-setup/05-overrides.md @@ -15,6 +15,8 @@ docker compose -f compose.yaml -f overrides/compose.mariadb.yaml -f overrides/co | compose.noproxy.yaml | Exposes the application directly on port `:8080` without a reverse proxy | | | compose.proxy.yaml | Uses Traefik as HTTP reverse proxy on port `:80` | You can change the published port by setting `HTTP_PUBLISH_PORT` | | compose.https.yaml | Uses Traefik as HTTPS reverse proxy on Port `:443` with automatic HTTP-to-HTTPS redirect | `SITES_RULE` and `LETSENCRYPT_EMAIL` must be set. `HTTP_PUBLISH_PORT` and `HTTPS_PUBLISH_PORT` can be set. | +| compose.nginxproxy.yaml | Uses nginx-proxy as HTTP reverse proxy on port `:80` | Set `NGINX_PROXY_HOSTS`. You can change the published port by setting `HTTP_PUBLISH_PORT` | +| compose.nginxproxy-ssl.yaml | Uses nginx-proxy + acme-companion for HTTPS on port `:443` with automatic certificates | Set `NGINX_PROXY_HOSTS` and `LETSENCRYPT_EMAIL`. `HTTP_PUBLISH_PORT` and `HTTPS_PUBLISH_PORT` can be set. | | **Redis** | | | | compose.redis.yaml | Adds Redis service for caching and background job queuing | | **TBD** | **The following overrides are available but lack documentation. If you use them and understand their purpose, please consider contributing to this documentation.** | diff --git a/docs/getting-started.md b/docs/getting-started.md index c3411744..e67f7415 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -93,8 +93,15 @@ Docker Compose "overrides" that extend the base compose.yaml for different scena - **compose.mariadb.yaml** - Adds MariaDB database service - **compose.redis.yaml** - Adds Redis caching service -- **compose.proxy.yaml** - Adds Traefik reverse proxy for multi-site hosting -- **compose.https.yaml** - Adds SSL/TLS certificate management +- **compose.proxy.yaml** - Adds Traefik reverse proxy for multi-site hosting (label-based routing) +- **compose.https.yaml** - Adds Traefik HTTPS + automatic certs (uses `SITES_RULE`) +- **compose.nginxproxy.yaml** - Adds nginx-proxy reverse proxy (HTTP, env-based `VIRTUAL_HOST`) +- **compose.nginxproxy-ssl.yaml** - Adds nginx-proxy + acme-companion (HTTPS, env-based `LETSENCRYPT_HOST`) + +**Proxy choice:** + +- Traefik is more flexible for advanced routing and multi-bench setups +- nginx-proxy is simpler for a single bench with host-based routing. ### 📁 development/ - Dev Environment