From 166a9040414d522a9d7ea2faf0f53b17cad21931 Mon Sep 17 00:00:00 2001 From: Rocket-Quack <202538874+Rocket-Quack@users.noreply.github.com> Date: Mon, 19 Jan 2026 15:24:43 +0100 Subject: [PATCH] docs: deprecation note for SITES in favor of SITES_RULE for v3 traefik --- docs/02-setup/04-env-variables.md | 4 ++++ docs/02-setup/05-overrides.md | 2 ++ 2 files changed, 6 insertions(+) diff --git a/docs/02-setup/04-env-variables.md b/docs/02-setup/04-env-variables.md index 1001c888..c49cdc50 100644 --- a/docs/02-setup/04-env-variables.md +++ b/docs/02-setup/04-env-variables.md @@ -60,6 +60,10 @@ SITES=`mysite.example.com` SITES=`{any:.+}` ``` +>Note: `SITES` currently supplies the host list that goes into the `Host(...)` rules. Once the Traefik v3 transition is completed, the plan is to switch to `SITES_RULE` (full rule expression) and deprecate `SITES` to map the Traefik Rule Syntax. + +>Currently the used syntax is pinned to v2 via `--core.defaultRuleSyntax=v2`). + --- ## Site Configuration diff --git a/docs/02-setup/05-overrides.md b/docs/02-setup/05-overrides.md index 9188489d..783868f7 100644 --- a/docs/02-setup/05-overrides.md +++ b/docs/02-setup/05-overrides.md @@ -4,6 +4,8 @@ Overrides extend the base compose.yaml with additional services or modify existi docker compose -f compose.yaml -f overrides/compose.mariadb.yaml -f overrides/compose.redis.yaml config > compose.custom.yaml ``` +Note: The Traefik-based overrides uses Traefik v3.6 and `--core.defaultRuleSyntax=v2` for compatibility with existing traefik v2.11. This flag is temporary and will be removed once the transition to v3.6 is completed. + | Overrider | Purpose | Additional Info | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Database** | | |