rezytijo/docker-traefik-cloudflare-companion repository overview

⁠github.com/rezytijo/docker-traefik-cloudflare-companion

⁠About

This will build a Docker image to automatically update Cloudflare⁠ DNS records upon container start when using Traefik⁠ as a Reverse Proxy.

⁠Maintainer

• Dave Conroy⁠

⁠Table of Contents

• About⁠
• Maintainer⁠
• Table of Contents⁠
• Prerequisites and Assumptions⁠
• Installation⁠
  • Build from Source⁠
  • Prebuilt Images⁠
    • Multi Architecture⁠
• Configuration⁠
  • Quick Start⁠
  • Persistent Storage⁠
  • Environment Variables⁠
    • Base Images used⁠
    • Container Options⁠
    • Docker Options⁠
    • Cloudflare Options⁠
    • Traefik Options⁠
    • Docker Secrets⁠
  • Discovery⁠
    • Docker⁠
    • Docker Swarm⁠
    • Traefik Polling⁠
      • Filtering⁠
        • Include Patterns⁠
        • Exclude Patterns⁠
        • By Label (Docker Endpoint only)⁠
• Maintenance⁠
  • Shell Access⁠
• Support⁠
  • Usage⁠
  • Bugfixes⁠
  • Feature Requests⁠
  • Updates⁠
• License⁠
• References⁠

⁠Prerequisites and Assumptions

• Assumes you have either a Global or a Scoped API key from Cloudflare.
• Assumes you are using Traefik as a reverse proxy:
  • Traefik⁠

⁠Installation

⁠Build from Source

Clone this repository and build the image with docker build -t (imagename) .

⁠Prebuilt Images

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⁠:

⁠Multi Architecture

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)

⁠Configuration

⁠Quick Start

• 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`)

⁠Persistent Storage

⁠Environment Variables

⁠Base Images used

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:

⁠Container Options

⁠Docker Options

⁠Cloudflare Options

⁠Traefik Options

⁠Docker Secrets

CF_EMAIL and CF_TOKEN support Docker Secrets Name your secrets either CF_EMAIL and CF_TOKEN or cf_email and cf_token.

⁠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:

⁠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 Polling

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:

1. Provider is not docker
2. Status is enabled
3. Name is present
4. Rule contains Host(...)
5. Host matches include patterns (default: .*)
6. Host does not match exclude patterns (default: none)

The polling interval can be configured by setting the environment variable TRAEFIK_POLL_SECONDS=120.

⁠Filtering

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

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

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.

⁠By Label (Docker Endpoint only)

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

⁠Maintenance

⁠Shell Access

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) bash

⁠Support

These 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.

⁠Usage

• 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.

⁠Bugfixes

• Please, submit a Bug Report⁠ if something isn't working as expected. I'll do my best to issue a fix in short order.

⁠Feature Requests

• 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.

⁠Updates

• 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.

⁠License

MIT. See LICENSE⁠ for more details.

⁠References

• https://www.cloudflare.com⁠
• https://github.com/tiredofit/docker-traefik-cloudflare-companion⁠
• https://github.com/code5-lab/dns-flare⁠