Cloudflare DDNS

Cloudflare DDNS is a configurable Docker service updating your CloudFlare DNS records periodically to match your local IP address.

Table of Content

• Cloudflare DDNS
• Table of Content
  • Installation
    • Using a Pre-built Container
    • Building the Container Yourself
      • Hosting
    • Running on the Host
  • Configuration
    • Getting a Cloudflare Token
    • Supported Options
  • Contributing

Installation

While this project is intended to be ran as a Docker container, it can also be ran on the host directly.

This container runs until terminated. It is not a cron job.

Using a Pre-built Container

This project is available on the GitHub Container Registry.

docker pull git.home.timatlee.com/timatlee/cloudflare-ddns:latest

Building the Container Yourself

There are no special requirements when building this container. Simply build with:

docker build -t git.home.timatlee.com/timatlee/cloudflare-ddns:latest .
docker push git.home.timatlee.com/timatlee/cloudflare-ddns:latest

Hosting

I am hosting this in my own Gitea repository. We can push this with:

docker login git.home.timatlee.com
username: timatlee
password: // Gitea PAT token

Running on the Host

Python > 3.12 is required. This likely requires a virtualenv.

python -m venv .env
.env\scripts\activate.ps1
pip install -r requirements.txt
python -m cloudflare_ddns --token ... -d .. domain.example.com

In order to run this project on the host, you'll need Python > 3.8, and an environment containing the dependencies listed in requirements.txt.

The project can then by launched by running the cloudflare_ddns module, usually using python -m cloudflare_ddns.

Configuration

This project will accept parameters through environment variables or command line argument. Feel free to select the method fitting your setup the best!

Getting a Cloudflare Token

The first step will be to create an API token with the following scopes:

• Zone:Read
• DNS:Edit

Supported Options

We currently support following settings:

Parameter Name	Short Command Line Option	Long Command Line Option	Environment Variable	Description
Token [mandatory]	-k	--token	CF_DDNS_TOKEN	Your Cloudflare token created in the previous step.
Delay [default: 5 minutes]	-d	--delay	CF_DDNS_DELAY	The time to wait between each update. It is parsed per strftime.

The domains to update will have to either be passed as command line arguments after the options or with a space separated CF_DDNS_DOMAINS environment variable.

Each domain can be preceded by the record type, either A or AAAA, followed by a colon. Otherwise any found A or AAAA record pointing to this domain found will be used.

Contributing

Any help would be greatly appreciated! Feel free to check our open issues and send us a Pull Request!