EV21/dynb
1
0
Fork 0
mirror of https://github.com/EV21/dynb.git synced 2025-12-26 16:39:32 +01:00
Code Issues Projects Releases Wiki Activity

Compare commits

base: EV21:0.4.0
Branches Tags
EV21:main EV21:noip
EV21:0.5.3 EV21:0.5.2 EV21:0.5.1 EV21:0.5.0 EV21:0.4.0 EV21:0.3.5 EV21:0.3.4 EV21:0.3.3 EV21:0.3.2 EV21:0.3.1 EV21:0.3.0 EV21:0.2.0 EV21:0.1.2 EV21:0.1.1 EV21:0.1.0
..
compare: EV21:noip
Branches Tags
EV21:main EV21:noip
EV21:0.5.3 EV21:0.5.2 EV21:0.5.1 EV21:0.5.0 EV21:0.4.0 EV21:0.3.5 EV21:0.3.4 EV21:0.3.3 EV21:0.3.2 EV21:0.3.1 EV21:0.3.0 EV21:0.2.0 EV21:0.1.2 EV21:0.1.1 EV21:0.1.0

1 Commits
0.4.0 ... noip

Author SHA1 Message Date
Eduard Veit
1f31d943ca ✨ add DynDNS2 support for noip.com 2021-11-03 23:24:39 +01:00
7 changed files with 440 additions and 671 deletions
Expand all files Collapse all files

2
.gitchangelog.rc
View File

@@ -158,7 +158,7 @@ body_process = ReSub(r'((^|\n)[A-Z]\w+(-\w+)*: .*(\n\s+.*)*)+$', r'') | strip
##
## Available constructs are those listed in ``body_process`` doc.
subject_process = (strip |
ReSub(r'^([cC]hg|[fF]ix|[nN]ew|[dD]oc|[fF]eat|[aA]dd|[cC]hange)\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n@]*)(@[a-z]+\s+)*$', r'\4') |
ReSub(r'^([cC]hg|[fF]ix|[nN]ew)\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n@]*)(@[a-z]+\s+)*$', r'\4') |
SetIfEmpty("No commit message.") | ucfirst | final_dot)

16
.github/workflows/shellcheck.yml vendored
View File

@@ -1,16 +0,0 @@
name: Run shellcheck with reviewdog
on: [pull_request]
jobs:
shellcheck:
name: runner / shellcheck
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: shellcheck
uses: reviewdog/action-shellcheck@v1.9.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: github-pr-review
path: "."
pattern: "*.sh"
exclude: "./.git/*"

1
.gitignore vendored
View File

@@ -1,3 +1,2 @@
.env*
docker-compose*
.vscode

205
CHANGELOG.md
View File

@@ -1,190 +1,127 @@
# Changelog
## 0.4.0 (2022-11-07)
### Features
* ✨ add support for dynu.com as DynDNS2 provider. [Eduard Veit]
### Documentation
* 📝 add dynu.com as DynDNS2 provider. [Eduard Veit]
## 0.3.5 (2022-11-03)
### Features
* ✨ add support for IPv64.net as DynDNS2 provider. [Eduard Veit]
### Fix
* Delete status file after success. [Eduard Veit]
* More status file issues. [Eduard Veit]
* Incorrect status code handling. [Eduard Veit]
no persistent status file was written in case of an error as the return status code was always 0
### Documentation
* 📝 change TTL to 60 for IPv64.net. [Eduard Veit]
* 📝 add IPv64.net as DynDNS2 provider. [Eduard Veit]
## 0.3.4 (2022-06-30)
### Features
* ✨ add support for ddnss.de as DynDNS2 provider. [Eduard Veit]
### Documentation
* 📝 update providers in README. [Eduard Veit]
## 0.3.3 (2022-06-07)
### Fix
* Wrong parameter name for DuckDNS. [Eduard Veit]
### Documentation
* 📝 add comments to docker-compose.yml example. [Eduard Veit]
## 0.3.2 (2022-05-26)
### Features
* ✨ add tzdata to Dockerfile for timezone config. [Eduard Veit]
You can now set your timezone with the environment variable
`TZ="Europe/Berlin"`
## 0.3.1 (2022-05-26)
### Fix
* 🐛 curl/libcurl doesn't support dns-server option. [Eduard Veit]
the latest alpine we are using for the docker image
does also drops the support for that option like debian/ubuntu/etc
## 0.3.0 (2022-05-26)
### Features
* ✨ validate ip address respons from ip check web service. [Eduard Veit]
* ✨ check internet connection for selected ip versions. [Eduard Veit]
* 🎨 colorful info, debug and error messages. [Eduard Veit]
### Fix
* Abort on all dig errors. [Eduard Veit]
### Documentation
* 📝 add labels to Dockerfile. [Eduard Veit]
## 0.2.0 (2021-09-24)
### Features
### New
* ✨ enable parameter extensions for `docker run --interactive` [Eduard Veit]
* :sparkles: enable parameter extensions for `docker run --interactive` [Eduard Veit]
### Changed
* :sparkles: add pre-commit hooks for markdown. [Eduard Veit]
* Handle dns server selection. [Eduard Veit]
* :sparkles: change git hooks and add shfmt. [Eduard Veit]
* :sparkles: add pre-commit git hook for shellcheck. [Eduard Veit]
### Changes
* :wrench: remove md-toc from pre-commit. [Eduard Veit]
* :wrench: handle dns server selection. [Eduard Veit]
### Documentation
* 📝 update CHANGELOG.md. [Eduard Veit]
* :memo: update CHANGELOG.md. [Eduard Veit]
* 📝 document docker parameters. [Eduard Veit]
* :memo: document docker parameters. [Eduard Veit]
* 📝 change default dns server setting. [Eduard Veit]
* :memo: change default dns server setting. [Eduard Veit]
* 📝 update CHANGELOG. [Eduard Veit]
* :memo: update CHANGELOG. [Eduard Veit]
* 📝 update README.md. [Eduard Veit]
* :memo: update README.md. [Eduard Veit]
### Other
* :art: lint README.md. [Eduard Veit]
* :art: add shfmt params to pre-commit check. [Eduard Veit]
* :art: fix shell style. [Eduard Veit]
* :recycle: seperate parsing logic. [Eduard Veit]
* :recycle: normalizing pre-commit configuration to a top-level map. [Eduard Veit]
* :recycle: refactorings. [Eduard Veit]
* Refactor: :recycle: remove unused help message. [Eduard Veit]
## 0.1.2 (2021-04-23)
### Documentation
* 📝 document environment variables. [Eduard Veit]
* :memo: document environment variables. [Eduard Veit]
### Other
* :recycle: refactor: method extractions and other beautifications. [Eduard Veit]
## 0.1.1 (2021-04-23)
### Fix
* 🐛 fix loop and error handling in case of connection issues. [Eduard Veit]
* :bug: fix loop and error handling in case of connection issues. [Eduard Veit]
## 0.1.0 (2021-04-22)
### Features
### New
* ✨ add Dockerfile. [Eduard Veit]
* :sparkles: add Dockerfile. [Eduard Veit]
* ✨ add loop mode. [Eduard Veit]
* :sparkles: add loop mode. [Eduard Veit]
* ✨ add support for Duck DNS as DynDNS2 provider. [Eduard Veit]
* :sparkles: add support for Duck DNS as DynDNS2 provider. [Eduard Veit]
* ✨ add support for deSEC as DynDNS2 provider. [Eduard Veit]
* :sparkles: add support for deSEC as DynDNS2 provider. [Eduard Veit]
* ✨ add completion. [Eduard Veit]
* :sparkles: add completion. [Eduard Veit]
✨ add man page
:sparkles: add man page
* 🔃 replace getopt with argbash. [Eduard Veit]
* :sparkles: replace getopt with argbash. [Eduard Veit]
* ✨ add interpretaton of status codes and act accordingly. [Eduard Veit]
* :sparkles: add interpretaton of status codes and act accordingly. [Eduard Veit]
* ✨ make network interface configurable. [Eduard Veit]
* :sparkles: make network interface configurable. [Eduard Veit]
* ✨ add DynDNS2 support for dynv6.com. [Eduard Veit]
* :sparkles: add DynDNS2 support for dynv6.com. [Eduard Veit]
### Added
* :sparkles: add .gitchangelog.rc. [Eduard Veit]
* 📝 README.md. [Eduard Veit]
* ✨ dynb.sh. [Eduard Veit]
### Changed
* 🔃 rename environment variables. [Eduard Veit]
* :sparkles: add dynb.sh. [Eduard Veit]
### Fix
* 🐛 fix error handling. [Eduard Veit]
* :bug: fix sourcing of config file. [Eduard Veit]
* 🐛 fix sourcing of config file. [Eduard Veit]
♻️ do some shellcheck fixes
:recycle: do some shellcheck fixes
### Documentation
* 📝 document example of an docker-compose.yml file. [Eduard Veit]
* :memo: document example of an docker-compose.yml file. [Eduard Veit]
* 📝 document `loop mode` and mention `dig` as requirement. [Eduard Veit]
* :memo: document loop mode and dig as requirement. [Eduard Veit]
* 📝 update example of .env in README.md. [Eduard Veit]
* :memo: update example of .env in README.md. [Eduard Veit]
* 📝 CHANGELOG.md. [Eduard Veit]
* :memo: add CHANGELOG.md. [Eduard Veit]
* 📝 add example.env. [Eduard Veit]
* :memo: add example.env. [Eduard Veit]
* :memo: write README.md. [Eduard Veit]
### Other
* :recycle: refactor: rename environment variables. [Eduard Veit]
* :recycle: refactor, fix and debug error handling. [Eduard Veit]
* :recycle: refactor main code. [Eduard Veit]
* Initial commit. [EV21]

3
Dockerfile
View File

@@ -7,8 +7,7 @@ apk add \
bash \
curl \
jq \
bind-tools \
tzdata
bind-tools
WORKDIR /usr/src/app

58
README.md
View File

@@ -7,6 +7,8 @@ IPv4 (A) and IPv6 (AAAA) record updates are supported.
<!-- TOC -->
- [✨ Update Methods](#-update-methods)
- [APIs](#apis)
- [DynDNS2](#dyndns2)
- [📦 Requirements](#-requirements)
- [🚀 Installation](#-installation)
- [⚙ Configuration](#-configuration)
@@ -23,16 +25,18 @@ IPv4 (A) and IPv6 (AAAA) record updates are supported.
The following update methods are currently implemented:
| Provider | API | TTL in seconds | Credentials | own domain via NS record | free (sub-) domain |
|---------------------|-----------------------|----------------|----------------------------------------------------------------------------------------------|--------------------------|------------------------------------------------|
| INWX.com | Domrobot JSON-RPC-API | 300 | customer login `username` & `password`. Mobile TAN (OTP) is currently not supported by DynB. | ✔️ | ⛔ choose one of your owned domains |
| INWX.com | DynDNS2 | 60 | specific dyndns `username` & `password` | ✔️ | ⛔ choose one of your owned domains per account |
| deSEC.io (dedyn.io) | DynDNS2 | 60 | `token` | ✔️ | ✔️ |
| DuckDNS.org | DynDNS2 | 60 | `token` | ⛔ | ✔️ |
| dynv6.com | DynDNS2 | 60 | `token` | ✔️ | ✔️ |
| ddnss.de | DynDNS2 | 10 | `update key` as `token` | ⛔ | ✔️ |
| IPv64.net | DynDNS2 | 60 | `DynDNS Updatehash` as `token` | ⛔ | ✔️ |
| dynu.com | DynDNS2 | 30 | `username` & `password` | ✔️ | ✔️ |
### APIs
- INWX.com Domrobot JSON-RPC-API\
Limitations:
- minimum TTL is 300 (5 minutes)
### DynDNS2
- INWX.com
- deSEC.io (dedyn.io)
- DuckDNS.org
- dynv6.com
## 📦 Requirements
@@ -53,7 +57,7 @@ or simply clone this repo
git clone https://github.com/EV21/dynb.git
```
If you want to add the script to you PATH, run 👇
If you want to add the script to you PATH, run :point_down:
```shell
bash dynb.sh --link
@@ -75,7 +79,7 @@ DYNB_SERVICE_PROVIDER=inwx
## update method options: domrobot, dyndns
DYNB_UPDATE_METHOD=domrobot
## ip mode could be either: 4, 6 or 64 for dualstack
## ip mode could be either: 4, 6 or dual for dualstack
DYNB_IP_MODE=64
## If you are using the DomRobot RPC-API enter your credentials for the web interface login here
@@ -88,14 +92,14 @@ DYNB_TOKEN=
## 🏃 Run
If you have a config file just run 👇
If you have a config file just run :point_down:
```bash
dynb
```
Alternatively you can use parameters if your system meets the relevant requirements. This example shows the long form parameter, there are also short ones.\
Call the help function 👇
Call the help function :point_down:
```bash
dynb --help
@@ -119,13 +123,13 @@ Just use the parameter `--interval 60` or the environment variable `DYNB_INTERVA
### crontab
execute 👇
execute :point_down:
```bash
crontab -e
```
then add the following line 👇 to run dynb every five minutes.
then enter :point_down: to run dynb every five minutes.
```bash
*/5 * * * * $HOME/.local/bin/dynb >> $HOME/.local/share/dynb/dynb-cron.log
@@ -151,33 +155,25 @@ services:
image: ev21/dynb
container_name: dynb
network_mode: host
stdin_open: true
tty: true
build:
context: .
dockerfile: ./Dockerfile
environment:
- DYNB_DYN_DOMAIN=dyndns.example.com
# Providers: deSec, DuckDNS, dynv6, inwx, ddnss, ipv64
- DYNB_SERVICE_PROVIDER=desec
# Possible update methods are: dyndns, domrobot
- DYNB_SERVICE_PROVIDER=inwx
- DYNB_UPDATE_METHOD=dyndns
# IP modes: 4 (IPv4 only), 6 (IPv6 only), 64 both
- DYNB_IP_MODE=64
# If your provider uses tokens use DYNB_TOKEN instead of DYNB_USERNAME and DYNB_PASSWORD
- DYNB_USERNAME=User42
- DYNB_PASSWORD=SuperSecretPassword
# The interval in seconds is the time the script waits before executing it again
- DYNB_INTERVAL=300
# TZ: Timezone setting for correct log time
- TZ=Europe/Berlin
# TERM: For colorful console output (attached mode)
- TERM=xterm-256color
- DYNB_INTERVAL=60
```
## environment variables
| variable | default value | description |
|-----------------------|-----------------|----------------------------------------------------------------------------------------------------------------|
| --------------------- | --------------- | -------------------------------------------------------------------------------------------------------------- |
| DYNB_DYN_DOMAIN | undefined | required; `dyndns.example.com` |
| DYNB_SERVICE_PROVIDER | undefined | required; `deSEC`, `duckdns`, `dynv6`, `inwx`, `ddnss`, `ipv64` |
| DYNB_SERVICE_PROVIDER | undefined | required; `deSEC`, `duckdns`, `dynv6`, `inwx` |
| DYNB_UPDATE_METHOD | undefined | required; `dyndns` or `domrobot` (with inwx) |
| DYNB_IP_MODE | undefined | required; `4`, `6` or `64` for both |
| DYNB_USERNAME | undefined | the requirement depends on your provider and the update method |

826
dynb.sh
View File

File diff suppressed because it is too large Load Diff