traefik-cloudflare-companion
traefik-cloudflare-companion
Docker app from Exes' Repository
Overview
This builds a Docker image to automatically update and create Cloudflare DNS records upon container start. A time saver if you are regularly moving containers around to different systems. This will allow you to set multiple zone's you wish to update.
IMPORTANT:
Discovery
cloudflare-companion supports three different discovery mode: Docker, Docker Swarm, and Traefik Polling. The Docker discovery mode is the only mode enabled by default. Once matching hosts are discovered, cloudflare-companion will add or update CNAMEs in CloudFlare that point to the configured TARGET_DOMAIN.
Docker
cloudflare-companion will discover running Docker containers by searching for supported labels.
The supported labels are:
Traefik Version Single Host Multiple Host
1 traefik.normal.frontend.rule=Host:example1.domain.tld traefik.normal.frontend.rule=Host:example1.domain.tld,example2.domain.tld
2 traefik.http.routers.example.rule=Host(`example1.domain.tld`) ``traefik.http.routers.example.rule=Host(example1.domain.tld)
Docker Swarm
Docker Swarm mode can be enabled by setting the environment variable SWARM_MODE=TRUE. This will cause cloudflare-companion to discover running Docker Swarm services with supported labels.
The supported labels are:
Traefik Version Single Host Multiple Host
1 traefik.normal.frontend.rule=Host:example1.domain.tld traefik.normal.frontend.rule=Host:example1.domain.tld,example2.domain.tld
2 traefik.http.routers.example.rule=Host(`example1.domain.tld`) ``traefik.http.routers.example.rule=Host(example1.domain.tld)
Runtime arguments
- Network
bridge- Shell
sh- Privileged
- false
- Extra Params
--restart unless-stopped
Template configuration
TRAEFIK_VERSIONVariable
- Value
- 2
DOCKER_ENTRYPOINTVariable
- Value
- unix://var/run/docker.sock
CF_TOKENVariable
DOMAIN1Variable
- Value
- domain.tld
DOMAIN2Variable
- Value
- domain2.tld
DOMAIN1_ZONE_IDVariable
DOMAIN1_PROXIEDVariable
- Value
- TRUE
DOMAIN2_ZONE_IDVariable
TARGET_DOMAINVariable
- Value
- domain.tld
DOMAIN1_PROXIEDVariable
- Value
- TRUE
TRAEFIK_VERSIONVariable
- Value
- 2
ENABLE_TRAEFIK_POLLVariable
- Value
- TRUE
TRAEFIK_POLL_URLVariable
- Value
- http://traefik-ip:traefik-webui-port
DockerPathro
- Target
- /var/run/docker.sock
- Value
- /var/run/docker.sock
DRY_RUNVariable
- Default
- FALSE
- Value
- FALSE
REFRESH_ENTRIESVariable
- Default
- FALSE
- Value
- TRUE
Categories
Download Statistics
14,366,020
Total Downloads
165,174
This Month
153,704
Avg / Month
Total Downloads Over Time
Loading chart...
Details
Repository
tiredofit/traefik-cloudflare-companion:latestLast Updated2025-04-30
First Seen2022-09-29
Run traefik-cloudflare-companion on Unraid.
traefik-cloudflare-companion is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.