cupcakearmy/docker-ddns-cloudflare
1
0
Fork 0
mirror of https://github.com/cupcakearmy/docker-ddns-cloudflare.git synced 2024-12-21 23:36:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Cloudflare DDNS Script
36 Commits 1 Branch 12 Tags 161 KiB
TypeScript 94.7%
Dockerfile 5.3%
c007fbb848
Go to file
borisbm c007fbb848
Update .sample.env
2022-05-13 19:37:57 +10:00
.github workflow 2021-05-05 12:10:29 +02:00
src Update index.ts 2022-05-13 19:37:27 +10:00
.dockerignore pnpm & typescript 2021-10-22 17:47:49 +02:00
.gitignore pnpm & typescript 2021-10-22 17:47:49 +02:00
.sample.env Update .sample.env 2022-05-13 19:37:57 +10:00
CHANGELOG.md 1.2.0 2022-02-07 13:14:23 +01:00
docker-compose.yml pnpm & typescript 2021-10-22 17:47:49 +02:00
Dockerfile 1.2.0 2022-02-07 13:14:23 +01:00
package.json update dependencies 2022-02-07 12:41:51 +01:00
pnpm-lock.yaml update dependencies 2022-02-07 12:41:51 +01:00
README.md badges 2022-04-07 12:05:47 +02:00
tsconfig.json pnpm & typescript 2021-10-22 17:47:49 +02:00

README.md

Docker DDNS Cloudflare

Docker Pulls Docker Image Size (tag) Docker Image Version (tag latest semver)

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.

  1. Create an .env file:
TOKEN=mytoken
# Or (Legacy mode)
EMAIL=my@mail.com
KEY=Global_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

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

ENV Reference

Env Description Default
EMAIL [Legacy] E-Mail of the Cloudflare account.
KEY [Legacy] Key for authentication.
TOKEN API Token that can be used instead of EMAIL & KEY.
ZONE Cloudflare zone where your domain is.
DNS_RECORD The actual DNS record that should be updated.
CRON Frequency of updates. */5 * * * *
RESOLVER The endpoint used to determine your public ip. https://api.ipify.org/

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/