Cloudflare DDNS Script
Go to file
cupcakearmy bb1aec25c0
workflow
2021-05-05 12:10:29 +02:00
.github workflow 2021-05-05 12:10:29 +02:00
.gitignore new version 2020-07-23 12:52:07 +02:00
.sample.env new version 2020-07-23 12:52:07 +02:00
CHANGELOG.md changelog 2021-05-05 12:09:52 +02:00
Dockerfile scripts 2020-07-29 09:25:02 +02:00
README.md Update README.md 2020-07-23 13:05:51 +02:00
docker-compose.yml clena up docker-compose 2021-05-05 12:10:18 +02:00
package.json dep update 2021-05-05 12:10:23 +02:00
script.js select also for a type 2020-07-29 09:19:28 +02:00
yarn.lock dep update 2021-05-05 12:10:23 +02:00

README.md

Docker DDNS Cloudflare

Features 🌈

  • Simple container for setting setting and updating cloudflare records to your local ip address.
  • Only makes requests if the IP has changed.
  • By default it runs once every minute and the IP is resolved by https://api.ipify.org/.

Quickstart 🚀

  1. Get your api token here (Top right -> My Profile -> API Tokens)

Click create token. You can then use the Edit DNS Zone template. Give it a name.

Settings

  1. Create an .env file:
EMAIL=my@mail.com
KEY=my_api_key
ZONE=example.org
DNS_RECORD=some.example.org
  1. Run the container
docker run -d --name ddns --restart always --env-file .env cupcakearmy/ddns-cloudflare

To check logs:

docker logs ddns

Docker-Copmose

With docker-compose:

git clone https://github.com/CupCakeArmy/docker-ddns-cloudflare.git
cp .sample.env .env
# Edit the .env file with your data
docker-compose up -d

Customize

Custom CRON

By default the script runs every 5 minutes. You can customize this by simply setting the CRON value in the .env file.

# .env

# e.g. every minute
CRON=* * * * *

Custom Resolver

By default the script checks the own ip by calling https://api.ipify.org/. This also can be configured. It has to be an endpoint that return a plain text containing the ip by get request.

# .env

RESOLVER=https://ipv4.icanhazip.com/