Giter Club home page Giter Club logo

docker-cloudflare's Introduction

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 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

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

docker-cloudflare's People

Contributors

starttoaster avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

docker-cloudflare's Issues

Changing of root domain A record when updating.

When updating and you have a root A type record (example.com) it changes the A type name to "example". Meaning that your site root won't work anymore ("example.com"), and instead it creates a subdomain ("example.example.com")

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.