Sign inSign up

starttoaster/cloudflare-ddns

By starttoaster

Updated over 7 years ago

Image
0

100K+

starttoaster/cloudflare-ddns repository overview

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.

Via docker run: docker run -d -e USER_EMAIL="[email protected]" -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

VariableFunctionRequired/Optional
-e INTERVALA number, in seconds, for how often to run the update job. Default is 5 minutes (300s)Optional
-e USER_EMAILThe email address associated with your Cloudflare accountRequired
-e USER_APIKEYA unique 'Global API Key' is assigned to every Cloudflare DNS userRequired
-e USER_ZONEA unique 'Zone ID' is assigned to each domain registered in a Cloudflare accountRequired

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

HardwareUtilization
Disk8.4MB
CPUBasically nothing
RAM1.1MB

Tag summary

Content type

Image

Digest

Size

1.8 MB

Last updated

over 7 years ago

docker pull starttoaster/cloudflare-ddns