Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.71 KB

README.md

File metadata and controls

38 lines (29 loc) · 1.71 KB

Cloudflare DNS Updater

The Cloudflare DNS Updater (AutoDNS) is a Flask-based application designed to automate the updating of A records on Cloudflare. Using GUIDs for DNS record identification, it features automatic IP detection from incoming requests and integrates with Apprise for sending notifications upon successful updates or when errors occur.

Features

  • Automatic IP Detection: Determines the client IP from incoming requests. When behind a trusted reverse proxy, trusts X-Forwarded-For only from configured proxy IPs.
  • GUID-based Identification: Securely identifies the DNS record to update using GUIDs.
  • Notifications: Sends notifications through a variety of services using Apprise upon successful updates or errors.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Docker and Docker Compose installed on your machine.
  • A Cloudflare account and API token with DNS edit permissions.

Enviormental Variables

  • CF_ZONE_ID - Cloudflare Zone ID for the DNS records you are updating.
  • CF_API_TOKEN - API token used to authenticate with Cloudflare’s API.
  • APPRISE_URLS- Comma-separated URLs for notification services
  • TRUSTED_PROXIES - Comma-separated IPs of trusted reverse proxies. When set, X-Forwarded-For is only trusted from these IPs. When empty, remote_addr is always used.
docker run -d \
  --name autodns \
  --restart unless-stopped \
  -p 4295:4295 \
  -v /your/path/to/config:/config \
  -e CF_ZONE_ID="your-zone-id" \
  -e CF_API_TOKEN="your-api-token" \
  -e APPRISE_URLS="your-apprise-urls-separated-by-commas" \
  -e AUTODNS_PORT=4295 \
  -e AUTODNS_HOST=0.0.0.0 \
  -e TRUSTED_PROXIES="" \
  ghcr.io/baker-scripts/autodns:develop