This will build a Docker image to automatically update Cloudflare DNS records upon container start when using Traefik as a Reverse Proxy.
- About
- Maintainer
- Table of Contents
- Prerequisites and Assumptions
- Installation
- Configuration
- Maintenance
- Support
- License
- References
- Assumes you have either a Global or a Scoped API key from Cloudflare.
- Assumes you are using Traefik as a reverse proxy:
Clone this repository and build the image with docker build -t (imagename) .
Builds of the image are available on Docker Hub
docker pull docker.io/tiredofit/traefik-cloudflare-companion:(imagetag)Builds of the image are also available on the Github Container Registry
docker pull ghcr.io/tiredofit/docker-traefik-cloudflare-companion:(imagetag)
The following image tags are available along with their tagged release based on what's written in the Changelog:
| Container OS | Tag |
|---|---|
| Alpine | :latest |
Images are built primarily for amd64 architecture, and may also include builds for arm/v6, arm/v7, arm64 and others. These variants are all unsupported. Consider sponsoring my work so that I can work with various hardware. To see if this image supports multiple architecures, type docker manifest (image):(tag)
-
The quickest way to get started is using docker-compose. See the examples folder for a working compose.yml that can be modified for development or production use.
-
Set various environment variables to understand the capabilities of this image.
Upon startup the image looks for a label containing traefik.frontend.rule (version 1) or Host* (version2) from your running containers of either updates Cloudflare with a CNAME record of your TARGET_DOMAIN. Previous versions of this container used to only update one Zone, however with the additional of the DOMAIN environment variables it now parses the containers variables and updates the appropriate zone.
For those wishing to assign multiple CNAMEs to a container use the following format:
- Traefik 1.x
- traefik.normal.frontend.rule=Host:example1.domain.tld,example2.domain.tld- Traefik 2.x
- traefik.http.routers.example.rule=Host(`example1.domain.tld`) || Host(`example2.domain.tld`)| File | Description |
|---|---|
/var/run/docker.sock |
You must have access to the docker socket in order to utilize this image |
This image relies on an Alpine Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash,curl,less,logrotate, nano.
Be sure to view the following repositories to understand all the customizable options:
| Image | Description |
|---|---|
| OS Base | Customized Image based on Alpine Linux |
| Parameter | Description | Default |
|---|---|---|
DRY_RUN |
Perform a test run without making any changes TRUE or FALSE |
FALSE |
LOG_LEVEL |
Logging Level INFO VERBOSE DEBUG |
INFO |
LOG_TYPE |
Log Type CONSOLE FILE BOTH |
BOTH |
LOG_FILE |
Log Filename | tcc.log |
LOG_PATH |
Log Path | /logs/ |
TCC_USER |
User to run application as (there is a user tcc that can be used) |
root |
| Parameter | Description | Default |
|---|---|---|
DOCKER_ENTRYPOINT |
Docker Entrypoint default (local mode) | unix://var/run/docker.sock |
DOCKER_HOST |
(optional) If using tcp connection e.g. tcp://111.222.111.32:2376 |
|
DOCKER_CERT_PATH |
(optional) If using tcp connection with TLS - Certificate location e.g. /docker-certs |
|
DOCKER_SWARM_MODE |
Enable Docker Swarm Mode TRUE or FALSE |
FALSE |
DOCKER_TLS_VERIFY |
(optional) If using tcp conneciton to socket Verify TLS | 1 |
| Parameter | Description | Default |
|---|---|---|
CF_EMAIL |
Email address tied to Cloudflare Account - Leave Blank for Scoped API | |
CF_TOKEN |
API Token for the Domain | |
RC_TYPE |
Record Type for The Cloudflare e.g. A;CNAME;AAAA |
CNAME |
TARGET_DOMAIN |
Destination Hostname/IP to forward records to e.g. host.example.com or 172.30.0.1 |
|
DOMAIN1 |
Domain 1 you wish to update records for. | |
DOMAIN1_ZONE_ID |
Domain 1 Zone ID from Cloudflare | |
DOMAIN1_PROXIED |
Domain 1 True or False if proxied | |
DOMAIN1_TARGET_DOMAIN |
(optional specify target_domain for Domain 1, overriding the default value from TARGET_DOMAIN) | |
DOMAIN1_EXCLUDED_SUB_DOMAINS |
(optional specify sub domain trees to be ignored in lables) ex: DOMAIN1_EXCLUDED_SUB_DOMAINS=int would not create a CNAME for *.int.example.com |
|
DOMAIN2 |
(optional Domain 2 you wish to update records for.) | |
DOMAIN2_ZONE_ID |
Domain 2 Zone ID from Cloudflare | |
DOMAIN2_PROXIED |
Domain 1 True or False if proxied | |
DOMAIN2_TARGET_DOMAIN |
(optional specify target_domain for Domain 2, overriding the default value from TARGET_DOMAIN) | |
DOMAIN2_EXCLUDED_SUB_DOMAINS |
(optional specify sub domain trees to be ignored in lables) ex: DOMAIN2_EXCLUDED_SUB_DOMAINS=int would not create a CNAME for *.int.example2.com |
|
DOMAIN3.... |
And so on.. | |
DEFAULT_TTL |
TTL to apply to records (1 = automatic, valid values: 60-86400 or 30-86400 for enterprise) | 1 |
| Parameter | Description | Default |
|---|---|---|
TRAEFIK_VERSION |
What version of Traefik do you want to work against - 1 or 2 |
2 |
ENABLE_TRAEFIK_POLL |
Enable Traefik Polling Mode TRUE or FALSE |
FALSE |
TRAEFIK_POLL_URL |
(optional) If using Traefik Polling mode - URL to Traefik API endpoint | |
TRAEFIK_POLL_SECONDS |
(optional) If using Traefik Polling mode - Seconds to delay between poll attemps | 60 |
TRAEFIK_FILTER_LABEL |
(optional) Filter by this label | traefik.constraint |
TRAEFIK_FILTER |
(optional) Filter by above Label and Value | |
TRAEFIK_INCLUDED_HOST1 |
(optional) If using Traefik Polling mode - Regex patterns for hosts to include | .* |
TRAEFIK_INCLUDED_HOST... |
(optional traefik host include pattern 2 - N) | |
TRAEFIK_EXCLUDED_HOST1 |
(optional) If using Traefik Polling mode - Regex patterns for hosts to exclude | |
TRAEFIK_EXCLUDED_HOST... |
(optional traefik host exclude pattern 2 - N) | |
REFRESH_ENTRIES |
If record exists, update entry with new values TRUE or FALSE |
FALSE |
CF_EMAIL and CF_TOKEN support Docker Secrets
Name your secrets either CF_EMAIL and CF_TOKEN or cf_email and cf_token.
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.
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 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) |
Traefik Polling mode can be enabled by setting the environment variable TRAEFIK_VERSION=2, ENABLE_TRAEFIK_POLL=TRUE, and TRAEFIK_POLL_URL=http://<host>:<port>. This will cause cloudflare-companion to poll Traefik every 60s (default) and discover routers and include hosts which match the following rules:
- Provider is not docker
- Status is enabled
- Name is present
- Rule contains Host(...)
- Host matches include patterns (default: .*)
- Host does not match exclude patterns (default: none)
The polling interval can be configured by setting the environment variable TRAEFIK_POLL_SECONDS=120.
Discovered hosts are matched against include and exclude patterns to determine if they should be included in the sync to CloudFlare. By default, all found hosts are included. Exclude patterns are higher priority than include patterns. The defaults can be changed by configuring include and exclude patterns.
Include patterns can be specified by defining one or more TRAEFIK_INCLUDED_HOST<XXX> variables such as TRAEFIK_INCLUDED_HOST1=.*-data\.foobar\.com and TRAEFIK_INCLUDED_HOST2=.*-api\.foobar\.com. The pattern is a regular expression that is used to determine if the host should be included.
Exclude patterns can be specified by defining one or more TRAEFIK_EXCLUDED_HOST<XXX> variables such as TRAEFIK_EXCLUDED_HOST1=private-data\.foobar\.com and TRAEFIK_EXCLUDED_HOST2=.*-internal-api\.foobar\.com. The pattern is a regular expression that is used to determine if the host should be excluded. Exclude patterns filter out results after include patterns are executed.
If both TRAEFIK_FILTER_LABEL and TRAEFIK_FILTER are set only operate on containers with these matching values. This is useful if running multiple copies of Traefik and multiple copies of Cloudflare companion on your system or cluster or to limit acting on specific containers. Example:
TRAEFIK_CONSTRAINT_LABEL=traefik.constraint
TRAEFIK_CONSTRAINT=proxy-public
In your serving container:
services:
nginx:
image: tiredofit/nginx:latest
deploy:
labels:
- traefik.enable=true
- traefik.http.routers.nginx.rule=Host(`nginx.example.com`)
- ...
- traefik.constraint=proxy-public
For debugging and maintenance purposes you may want access the containers shell.
docker exec -it (whatever your container name is e.g. traefik-cloudflare-companion) bashThese images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.
- The Discussions board is a great place for working with the community on tips and tricks of using this image.
- Sponsor me for personalized support.
- Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.
- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
- Sponsor me regarding development of features.
- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
- Sponsor me for up to date releases.
MIT. See LICENSE for more details.