Skip to content
This repository has been archived by the owner on May 5, 2024. It is now read-only.

dDNS container for Cloudflare. Continuously updates your DNS A Records at your desired intervals.

License

Notifications You must be signed in to change notification settings

Starttoaster/docker-cloudflare

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docker-cloudflare

dDNS container for Cloudflare A Records. Finds A Record identifiers and updates Cloudflare on your current IP address in adjustable time intervals.

Use

You can either start this container via docker run or docker-compose. I attached a sample docker-compose.yml file in the repo to use if desired.

Quick Start: docker run -d -e USER_EMAIL="email@email.com" -e USER_APIKEY="my_global_api_key" -e USER_ZONE="my_zone_id" starttoaster/cloudflare-ddns

NOTE: The bare minimum required details to interact with Cloudflare's DNS API is the account email, Global API Key, and Zone ID attributes. This container finds other necessary attributes without requiring user input by itself, but if you need help finding the 3 required attributes I listed, view the section below regarding "API Attributes".

Environment Variables

Variable Function Required/Optional
-e INTERVAL A number, in seconds, for how often to run the update job. Default is 5 minutes (300s) Optional
-e USER_EMAIL The email address associated with your Cloudflare account Required
-e USER_APIKEY A unique 'Global API Key' is assigned to every Cloudflare DNS user Required
-e USER_ZONE A unique 'Zone ID' is assigned to each domain registered in a Cloudflare account Required

NOTE: Please be nice to Cloudflare's API. Don't set a custom interval of less than a minute. About 3-5 minutes is pretty standard.

API Attributes

Email: This is simply the email address used to sign up for Cloudflare. This can be found under "My Profile".

Global API Key: This is found in the Cloudflare website under "My Profile > API Keys > Global API Key" See this link on finding the Global API Key

Zone Identifier: Found in the Cloudflare website on your domain's "Overview" page written as "Zone ID"

System Requirements

Hardware Utilization
Disk 4.24 MB
CPU Basically nothing
RAM 3.2 MB

Releases

No releases published

Packages

No packages published