Docker CloudFlare DDNS¶
This is a multi-arch image and will run on amd64, aarch64, and armhf devices, including the Raspberry Pi.
docker run \ -e API_KEY=xxxxxxx \ -e ZONE=example.com \ -e SUBDOMAIN=subdomain \ oznu/cloudflare-ddns
--restart=always- ensure the container restarts automatically after host reboot.
-e API_KEY- Your CloudFlare scoped API token. See the Creating a Cloudflare API token below. Required
API_KEY_FILE- Path to load your CloudFlare scoped API token from (e.g. a Docker secret). If both
-e ZONE- The DNS zone that DDNS updates should be applied to. Required
ZONE_FILE- Path to load your CloudFlare DNS Zone from (e.g. a Docker secret). If both
-e SUBDOMAIN- A subdomain of the
ZONEto write DNS changes to. If this is not supplied the root zone will be used.
SUBDOMAIN_FILE- Path to load your CloudFlare DNS Subdomain from (e.g. a Docker secret). If both
-e PROXIED- Set to
trueto make traffic go through the CloudFlare CDN. Defaults to
-e RRTYPE=A- Set to
AAAAto use set IPv6 records instead of IPv4 records. Defaults to
Afor IPv4 records.
-e DELETE_ON_STOP- Set to
trueto have the dns record deleted when the container is stopped. Defaults to
-e INTERFACE=tun0- Set to
tun0to have the IP pulled from a network interface named
tun0. If this is not supplied the public IP will be used instead. Requires
--network hostrun argument.
-e CUSTOM_LOOKUP_CMD="echo '184.108.40.206'"- Set to any shell command to run them and have the IP pulled from the standard output. Leave unset to use default IP address detection methods.
-e DNS_SERVER=10.0.0.2- Set to the IP address of the DNS server you would like to use. Defaults to 220.127.116.11 otherwise.
-e CRON="@daily"- Set your own custom CRON value before the exec portion. Defaults to every 5 minutes -
*/5 * * * *.
-e EMAIL- Your CloudFlare email address when using an Account-level token. This variable MUST NOT be set when using a scoped API token.
Creating a Cloudflare API token¶
To create a CloudFlare API token for your DNS zone go to https://dash.cloudflare.com/profile/api-tokens and follow these steps:
- Click Create Token
- Provide the token a name, for example,
- Grant the token the following permissions:
- Zone - Zone Settings - Read
- Zone - Zone - Read
- Zone - DNS - Edit
- Set the zone resources to:
- Include - All zones
- Complete the wizard and copy the generated token into the
API_KEYvariable for the container
If you need multiple records pointing to your public IP address you can create CNAME records in CloudFlare.
If you're wanting to set IPv6 records set the envrionment variable
RRTYPE=AAAA. You will also need to run docker with IPv6 support, or run the container with host networking enabled.
Copyright (C) 2017-2020 oznu
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.