Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 5.11 KB

README.md

File metadata and controls

89 lines (65 loc) · 5.11 KB
Raw

Cloudflare DNS IP Updater - Go version

Go Report Card Docker Pulls Docker Image Size (tag)

If you have some self-hosted services exposed to the internet but not a static public IP, you certainly faced the annoying task to access the CloudFlare dashboard and manually change all your records with the new IP everytime it changes.

What if I tell you that it can be automated? With this simple application you just have to spin a Docker container and not worry about your IP changing anymore.

It will continuously run and fetch your public IP at a given interval, detecting if it changes and sending a request to the CloudFlare API to update you records. You can even choose to be notified by email when that happens.

This is based on the daruzero/cloudflare-dns-auto-updater python script, but it has been rewritten in Go.

⚠️ Be aware, this only works if you are using the Cloudflare DNS.

Requirements

  • A CloudFlare account
  • Cloudflare Global API Key
  • The domain name you want to change the record of
  • (optional) The ID of the A record you want to change (how to)

Installation

  • Plain Docker

    docker run -d \
  -e EMAIL=<YOUR_CF_LOGIN_EMAIL> \
  -e AUTH_KEY=<YOUR_API_KEY> \
  -e ZONE_NAME=<YOUR_ZONE_NAME> \
  daruzero/cfautoupdater-go:latest

  • Docker Compose (see .env.example for the env file)

    version: '3.8'

services:
  app:
    image: daruzero/cfautoupdater-go:latest
    env_file: .env
    restart: unless-stopped

Environment variables

Required

Variable Example value Description
EMAIL [email protected] Email address associated with your CloudFlare account
AUTH_KEY c2547eb745079dac9320b638f5e225cf483cc5cfdda41 Your CloudFlare Global API Key
ZONE_NAME example.com The domain name that you want to change the record of. You can update multiple domains separating them with a , (comma)
ZONE_ID 372e67954025e0ba6aaa6d586b9e0b59 The ID of the zone you want to change a record of. You can update multiple domains separating them with a , (comma)

Note:

  • You only need to specify either ZONE_ID or ZONE_NAME. If you specify both, ZONE_ID will be used.

Optional

Variable Example value Description Default
RECORD_ID 372e67954025e0ba6aaa6d586b9e0b59 The ID of the record you want to change. Leave blank to update all records of the zone. -
CHECK_INTERVAL 86400 The amount of seconds the script should wait between checks 86400
SENDER_ADDRESS [email protected] The address of the email sender. Must use Gmail SMTP server -
SENDER_PASSWORD supersecret The password to authenticate the sender. Use an application password (tutorial) -
RECEIVER_ADDRESS [email protected] The address of the email receiver. Must use Gmail SMTP server -

Note:

  • SENDER_ADDRESS and RECEIVER_ADDRESS can be the same.

Future implementation

  • Possibility to update multiple domains
  • Support for other SMTP servers other than Google's
  • Support for other notification systems
    • SMS
    • Telegram
    • Discord
    • Slack
  • Support for other DNS services