Skip to content

n1cogrv/cloudflare-ddns-edgeos

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cloudflare DDNS Script for EdgeOS

GitHub release (latest by date) GitHub Repo stars made-with-bash License: WTFPL PR: Welcome

!!! README !!! Documentation/Usage - Refer to Blog Post

Usage

0 - Prerequisite

Make sure you have following dependencies installed.

  • curl
  • jq
  • ip

1 - Download

Suppose you have already ssh into your EdgeOS based router, in my case, Ubiquiti ER-X(v1.10.11).

1.1 Using Github Raw

cd /config/scripts/ && pwd
# /config/scripts/

curl -LS -o /config/scripts/cloudflare-ddns-edgeos.tar.gz https://github.com/n1cogrv/cloudflare-ddns-edgeos/raw/releases/cloudflare-ddns-edgeos.tar.gz

1.2 Trouble with GFW?

JsDelivr Github CDN

cd /config/scripts/ && pwd
# /config/scripts/

curl -LS -o /config/scripts/cloudflare-ddns-edgeos.tar.gz https://cdn.jsdelivr.net/gh/n1cogrv/cloudflare-ddns-edgeos@releases/cloudflare-ddns-edgeos.tar.gz

2 - Deploy

2.1 - Extraction

tar -xvf /config/scripts/cloudflare-ddns-edgeos.tar.gz

2.2 - Global Parameters Editing

!!! This step is IMPORTANT !!!

Alter variables in /config/scripts/cloudflare-ddns-edgeos/cfddns.sh

Meanings & where-can-be-found of global parameters is provided in cfddns.sh via code comments.

2.2.1 - Cloudflare Access Token

Variable in cfddns.sh - CF_ACCESS_TOKEN

Visit Cloudflare Api-tokens, Click Create Token.

Cloudflare Access Token 1

Use Edit zone DNS template.

Cloudflare Token Template

Fill in the form.

Cloudflare Token Detail

Continue to Summary, and Create Token.

Copy following token string into CF_ACCESS_TOKEN, starting with Bearer .

Cloudflare Token String

2.2.2 - Zone Identifier

Variable in cfddns.sh - ZONE_IDENTIFIER.

Zone Identifier

2.2.3 - Record Name

Variable in cfddns.sh - RECORD_NAME

Full domain name(With subdomain)

eg. subdomain.mijazz.icu, example.subdomain.yourdomain.com

2.3 - Extra Steps

+x to files using chmod +x /config/scripts/cloudflare-ddns-edgeos/cfddns.sh

3 - Test

Before you set it as a scheduled task, dryrun/execute it first.

/config/scripts/cloudflare-ddns-edgeos/cfddns.sh

If it creates and updates your domain record both successfully and correctly, proceed to next step.

Otherwise, feel free to open a issue

4 - Using task-scheduler to cron it

configure

set system task-scheduler task cloudflareddns executable path /config/scripts/cloudflare-ddns-edgeos/cfddns.sh
set system task-scheduler task cloudflareddns interval 20m

commit
save
exit

About this project

Inspired by rehiy/dnspod-shell, I wrote this project. At the beginning, this is just a random script I wrote and configured it on my router with crontab, all because of my sudden switch of dns provider.

There're plenty of ddns(ddns-client) projects on Github.

  • Some of them are written in shell-script and don't require extra language or framework support. (I don't want my poor router host a docker container everytime just for ddns update...)

  • Some of them are specifically optimized, ( or let's say ) , are only written for cloudflare ddns update, but in other language except shell-script.

Thus, cloudflare-ddns-edgeos aims at

  • For routers running EdgeOS (Ubiquiti EdgeRouter), light-weighted design.

  • Written in shell-script, avoid complex language and framework dependencies.

  • Specifically for Cloudflare DNS update, via Cloudflare v4 api.

And...EdgeOS didn't have official support for ddns on cloudflare, at least not an option in their web-ui. You need to configure it under cli, and it communicates with cloudflare through v1 api (currently v4 is actively supported & maintained by cloudflare)...

Release/Feature History

v1.2.1

v1.2

  • Continuous-Delivery via Github Action is configured, build and push artifact to releases branch.

v1.1

  • Automatically create dns record (No need to create record manually in advance).

  • Documentation & comments update (following shell style guideline).

v1.0-hotfix

  • Fix script import error. (MUST use absolute path to import cloudflare-ddns)

  • Update usage documentation.

v1.0

  • Initial release, test passed on er-x.

License

Copyright © 2022 MijazzChan [email protected]

This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See http://www.wtfpl.net/ for more details.