https://github.com/barreeeiroo/cloudflare-dns-updater
https://github.com/barreeeiroo/cloudflare-dns-updater
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/barreeeiroo/cloudflare-dns-updater
- Owner: barreeeiroo
- Created: 2024-12-07T16:54:51.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-01-15T22:20:20.000Z (5 months ago)
- Last Synced: 2025-03-28T00:53:30.673Z (2 months ago)
- Language: Python
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cloudflare DNS Updater
Simple Python project to update a Cloudflare DNS automatically, mimicking Dynamic DNS.
Just execute `python run.py`.
## Unraid Usage
> Requires the **Compose Manager** and **User Scripts** plugin.
1. Create the Zone and the target Record as an A record (with Auto or any custom TTL).
2. Request a new API Key in Cloudflare with both Read and Write permissions to the Zone.
3. Create a new Compose Manager Stack.
4. Set up a new User Scripts script to launch the container every minute.
### Compose Manager
```yml
name: cloudflare-dns
services:
cloudflare-dns-resolver:
container_name: cloudflare_resolver
image: ghcr.io/barreeeiroo/cloudflare-dns-resolver:latest
environment:
CF_API_EMAIL:
CF_API_KEY: "${CF_API_KEY}"
CF_ZONE_ID: "${CF_ZONE_ID}"
CF_ZONE_RECORD: "" # For example: "unraid.domain.org"
```
```env
CF_API_KEY=
CF_ZONE_ID=
```
### User Scripts
Run it on Custom Schedule at: `* * * * *` (every minute), for example.
```bash
#!/bin/bash
#backgroundOnly=true
#clearLog=true
docker container start cloudflare_resolver
```
### Enable Notifications
1. Create a pipe: `mkfifo /mnt/user/appdata/notify-pipe`.
2. Set up Unraid to listen and forward to the `notify` script (this is considered unsafe, make sure you don't use this
for anything else!):
```bash
while true; do eval "/usr/local/emhttp/webGui/scripts/notify $(cat /mnt/user/appdata/notify-pipe)"; done &
```
3. Add the following volume to the Docker Compose:
```yml
volumes:
- /mnt/user/appdata/notify-pipe:/notify-pipe
```