reaper0x1/cloudflare-ddns-updater repository overview

⁠Cloudflare DDNS Updater

⁠Table of Contents

• Description⁠
• Features⁠
• Docker Environment Variables⁠
• Getting Started⁠
  • Prerequisities⁠
  • Docker Compose⁠
  • Docker Compose with .env file⁠
  • Build Locally⁠
• Bash Script Usage⁠

⁠Description

This repository contains a Python script that dynamically updates a Cloudflare DNS "A" record with the machine's current public IP address. The script is intended to be run as a cron-like job, periodically checking the IP address and updating Cloudflare if a change is detected.

⁠Features

• Automatically fetches the public IP address of the local machine.
• Updates a specified Cloudflare DNS record if the public IP changes.
• Uses Cloudflare's API for secure DNS record management.
• Logs activity to both console and file.
• Configurable schedule using APScheduler with a cron-like syntax.
• Runs both locally with bash or in a container-friendly way.

⁠Docker Environment Variables

⁠Getting Started (Docker)

⁠Prerequisities

1. 🐋 Docker must be installed and configured.
2. You need to set your Cloudflare environment variable:
   • ZONE: this is your domain, for example mywebsite.com
   • DNS_RECORD: you need to put the Name of your A Record, for example mywebsite.com.
   • CLOUDFLARE_AUTH_KEY: in the Cloudflare dashboard go to Your Profile > API Token > Global API Key

⁠Docker Compose

services:
  cloudflare-ddns-updater:
    image: reaper0x1/cloudflare-ddns-updater:latest
    container_name: cloudflare-ddns-updater
    environment:
        # Put your cron schedule. 
        # You can generate one at https://crontab.guru/
        - CRON_SCHEDULE=0 */6 * * *
        # Your timezone
        - TZ=Europe/Berlin
        # Cloudflare
        - ZONE=site.com
        - DNS_RECORD=site.com
        - [email protected]
        - CLOUDFLARE_AUTH_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
        # Set to true if you want to export the json response error during the update of A Record
        - EXPORT_CF_UPDATE_ERROR_LOGS=false
        # Set to true if you want to start the script at the start of the container
        - EXECUTE_AT_START=false
        # The users belongs to files.
        - PUID=1000
        - PGID=1000
    # Comment out the following two lines if logs are not needed
    volumes:
      - ./logs:/app/logs
    restart: unless-stopped

⁠Docker Compose with .env file

services:
  cloudflare-ddns-updater:
    image: reaper0x1/cloudflare-ddns-updater:latest
    container_name: cloudflare-ddns-updater
    env_file: .env
    # Comment out the following two lines if logs are not needed
    volumes:
      - ./logs:/app/logs
    restart: unless-stopped

⁠Build Locally

services:
  cloudflare-ddns-updater:
    build: .
    container_name: cloudflare-ddns-updater
    env_file: .env
    # Comment out the following two lines if logs are not needed
    volumes:
      - ./logs:/app/logs
    restart: unless-stopped

⁠Bash Script Usage

This repository provides a bash script you can use if you don't want a Docker container.

1. Clone the repository:

   git clone https://github.com/Reaper0x1/cloudflare-ddns-updater && cd cloudflare-ddns-updater
   

   Copy

2. You have to edit these variables inside the script:

   • cloudflare_auth_email: the email of your Cloudflare account
   • cloudflare_auth_key: you can get it by going into Your Profile > API Token > Global API Key
   • zone: your Cloudflare website
   • dnsrecord: the name of the A record
   • (Optional): if you want to print out the whole Cloudflare response set export_cloudflare_update_logs=true

3. Run the script:

   ./ddns-updater.sh
   

   Copy

   If you want to log everything simply redirect the output to a file:

   ./ddns-updater.sh > log.txt
   

   Copy

4. (Optional) You can set up a cron job to run the script periodically.

   1. Edit the crontable:

      crontab -e
      

      Copy
   2. Add at the end of the file a line like the one below:

      0 */6 * * * /usr/bin/bash /path-to-script/ddns-updater.sh
      

      Copy
   3. (Optional) Redirect output to a file:

      0 */6 * * * /usr/bin/bash /path-to-script/ddns-updater.sh >> /path-to-log/ddns-updater.log
      

      Copy
   4. Save. You can check the cronjob with crontab -l