Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.71 KB

README.md

File metadata and controls

46 lines (29 loc) · 1.71 KB
Raw

ddns

Purpose

This project essentially is continuously running code that updates your primary DNS record in Cloudflare.

While some might argue that a cronjob could be better suited for this, I believe that the container uses such a small amount of resources that you can only benefit by having it run all the time.

Using this program

Cloudflare

Some environment variables are required:

  • ACCOUNT_TOKEN - The API token for your Cloudflare account.

OR

  • API_KEY - The API Key for the Cloudflare account
  • ACCOUNT_EMAIL - The Cloudflare account email address

Program Arguments

Container Mode

  1. --zone-name: The name of the zone you wish to modify.
  2. --record-name: The name of the record you wish to modify inside your zone.
  3. --provider: The provider you wish to use can be: ipify, icanhazip, icanhaz. Anything other than these three will be considered as "random"
  4. --ticker: Directly uses Golang's implementation of time.Duration. Default is "3m", you can set this to whatever you'd like.
  5. --create-missing: This will create the missing DNS record in the target if set to true, it is false by default.
  6. --record-ttl: This will set the DNS record to this TTL. 300 by default.

Serverless Mode

Does not use pflag library, set the environment variables above for Cloudflare and these

ZONE_NAME=<your name name>
RECORD_NAME=<your record name>

Example

Helm Release - Container Example Helm Release - Serverless Example