Portainer Templates logo

Portainer Templates

Cloudflare DDNS Cloudflare DDNS

Container

DNSTools

A robust Cloudflare DDNS updater with a small footprint. The program will detect your machine's public IP addresses and update DNS records using the Cloudflare API.

Image details

Pulls: 10.4M
Architecture: amd64, arm64, arm/v7, arm/v6, 386, ppc64le, s390x, riscv64
Image size: 5 MB
Latest: 1.17.0
User: favonia
Created: Jul 04, 2021
Updated: 2 days ago
Status: active

Source details

Stars: 3k
Forks: 115
Language: Go
License: Apache-2.0
Updated: 2 days ago

Configuration

Type
Container
Platform
linux
Image
favonia/cloudflare-ddns:latest
Env vars
CLOUDFLARE_API_TOKEN=DOMAINS=PROXIED=true
Restart
unless-stopped

Template by novaspirit

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://www.cloudflare.com/en-gb/learning/dns/glossary/dynamic-dns/
Official Docker Documentation: https://github.com/favonia/cloudflare-ddns/


Standalone Install

Select an install method, to see config/commands for deploying Cloudflare DDNS

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Cloudflare DDNS, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see favonia/cloudflare-ddns for app-specific guidance.

🌟 Cloudflare DDNS

Github Source Go Reference Codecov Docker Image Size OpenSSF Best Practices OpenSSF Scorecard
A small, feature-rich, and robust Cloudflare DDNS updater. Read the full documentation on GitHub.
Supported Tags:
  • latest: the latest stable version
  • edge: the development version
  • X: the latest stable version whose major version is X (e.g. 1)
  • X.Y.Z: a specific stable version

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs cloudflare-ddns
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Image won't pull

Test the pull directly on the host: docker pull favonia/cloudflare-ddns:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, arm/v6, 386, ppc64le, s390x, riscv64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect cloudflare-ddns --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Data disappears when the container is recreated

This template doesn't define any volumes, so everything cloudflare-ddns saves lives inside the container and is lost on update or recreate.

  • Add a volume mapping for cloudflare-ddns's data folder before storing anything you care about.

Required settings are blank

CLOUDFLARE_API_TOKEN, DOMAINS have no default value, and cloudflare-ddns may crash or misbehave if left empty.

  • Fill them in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Cloudflare DDNS runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Cloudflare DDNS needs bundled into one download. This template pulls favonia/cloudflare-ddns:latest, which Docker fetches once (about 5 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Cloudflare DDNS's comes from Docker Hub, published by favonia.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 1.17.0. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm/v6, 386, ppc64le, s390x, riscv64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

No stored data

This template doesn't mount any storage, so whatever Cloudflare DDNS writes stays inside the container and is wiped if it's recreated or updated. That's fine for something stateless, but add a volume before trusting it with anything you want to keep.

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Cloudflare DDNS takes 3 of them, and 2 need a value before it'll start properly:

  • CLOUDFLARE_API_TOKEN, needs a value
  • DOMAINS, needs a value. DOMAINS (Comma Separated List)
  • PROXIED, defaults to true

Restart policy

The restart policy here is unless-stopped, so Docker restarts Cloudflare DDNS after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Cloudflare DDNS sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container cloudflare-ddns. That's what you'll spot in the containers list and use in commands like docker logs cloudflare-ddns.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Cloudflare DDNS is open source, released under the Apache-2.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Cloudflare DDNS up. Add the template list to Portainer once, then deploying Cloudflare DDNS is a click rather than a wall of config.