Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oznu/docker-cloudflare-ddns
A small amd64/ARM/ARM64 Docker image that allows you to use CloudFlare as a DDNS / DynDNS Provider.
https://github.com/oznu/docker-cloudflare-ddns
aarch64 alpine-linux-image amd64 arm arm64 cloudflare ddns docker dyndns raspberry-pi x86-64
Last synced: 3 months ago
JSON representation
A small amd64/ARM/ARM64 Docker image that allows you to use CloudFlare as a DDNS / DynDNS Provider.
- Host: GitHub
- URL: https://github.com/oznu/docker-cloudflare-ddns
- Owner: oznu
- License: gpl-3.0
- Archived: true
- Created: 2017-08-21T09:07:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-08-10T14:57:48.000Z (over 2 years ago)
- Last Synced: 2024-09-21T16:20:19.988Z (3 months ago)
- Topics: aarch64, alpine-linux-image, amd64, arm, arm64, cloudflare, ddns, docker, dyndns, raspberry-pi, x86-64
- Language: Shell
- Homepage: https://hub.docker.com/r/oznu/cloudflare-ddns/
- Size: 85 KB
- Stars: 1,066
- Watchers: 25
- Forks: 213
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-cloudflare - Docker DDNS - Docker image to use the free DNS Service as a dynamic DNS provider. (DNS)
- awesome-cloudflare - Docker DDNS - Docker image to use the free DNS Service as a dynamic DNS provider. (DNS)
README
[](https://travis-ci.org/oznu/docker-cloudflare-ddns) [](https://hub.docker.com/r/oznu/cloudflare-ddns/)
# Docker CloudFlare DDNS
This small Alpine Linux based Docker image will allow you to use the free [CloudFlare DNS Service](https://www.cloudflare.com/dns/) as a Dynamic DNS Provider ([DDNS](https://en.wikipedia.org/wiki/Dynamic_DNS)).
This is a multi-arch image and will run on amd64, aarch64, and armhf devices, including the Raspberry Pi.
## Image Variants
| Image Tag | Architecture | OS | Size |
| :------------- | :-------------| :------------ | :---- |
| latest | x64 | Alpine Linux | [](https://microbadger.com/images/oznu/cloudflare-ddns) |
| armhf | arm32v6 | Alpine Linux | [](https://microbadger.com/images/oznu/cloudflare-ddns:armhf) |
| aarch64 | arm64 | Alpine Linux | [](https://microbadger.com/images/oznu/cloudflare-ddns:aarch64) |
## Usage
Quick Setup:
```shell
docker run \
-e API_KEY=xxxxxxx \
-e ZONE=example.com \
-e SUBDOMAIN=subdomain \
oznu/cloudflare-ddns
```
## Parameters
* `--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](#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 `API_KEY_FILE` and `API_KEY` are specified, `API_KEY_FILE` takes precedence.*
* `-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 `ZONE_FILE` and `ZONE` are specified, `ZONE_FILE` takes precedence.*
* `-e SUBDOMAIN` - A subdomain of the `ZONE` to 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 `SUBDOMAIN_FILE` and `SUBDOMAIN` are specified, `SUBDOMAIN_FILE` takes precedence.*
## Optional Parameters
* `-e PROXIED` - Set to `true` to make traffic go through the CloudFlare CDN. Defaults to `false`.
* `-e RRTYPE=A` - Set to `AAAA` to use set IPv6 records instead of IPv4 records. Defaults to `A` for IPv4 records.
* `-e DELETE_ON_STOP` - Set to `true` to have the dns record deleted when the container is stopped. Defaults to `false`.
* `-e INTERFACE=tun0` - Set to `tun0` to have the IP pulled from a network interface named `tun0`. If this is not supplied the public IP will be used instead. Requires `--network host` run argument.
* `-e CUSTOM_LOOKUP_CMD="echo '1.1.1.1'"` - 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 1.1.1.1 otherwise.
* `-e CRON="@daily"` - Set your own custom CRON value before the exec portion. Defaults to every 5 minutes - `*/5 * * * *`.
## Depreciated Parameters
* `-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:
1. Click Create Token
2. Provide the token a name, for example, `cloudflare-ddns`
3. Grant the token the following permissions:
* Zone - Zone Settings - Read
* Zone - Zone - Read
* Zone - DNS - Edit
4. Set the zone resources to:
* Include - All zones
5. Complete the wizard and copy the generated token into the `API_KEY` variable for the container
## Multiple Domains
If you need multiple records pointing to your public IP address you can create CNAME records in CloudFlare.
## IPv6
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.
## Docker Compose
If you prefer to use [Docker Compose](https://docs.docker.com/compose/):
```yml
version: '2'
services:
cloudflare-ddns:
image: oznu/cloudflare-ddns:latest
restart: always
environment:
- API_KEY=xxxxxxx
- ZONE=example.com
- SUBDOMAIN=subdomain
- PROXIED=false
```
## License
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](./LICENSE) for more details.