minor: 📝 update CHANGELOG

no persistent status file was written in case of an error as the return status code was always 0

.gitchangelog.rc

@@ -82,24 +82,34 @@ ignore_regexps = [
 ## whenever you are tweaking this variable.
 ##
 section_regexps = [
-    ('New', [
+    ('Features', [
-        r'^:sparkles\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+        r'^[fF]eat\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
      ]),
-    ('Changes', [
+    ('Added', [
-        r'^:wrench\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+        r'^[aA]dd\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+     ]),
+    ('Changed', [
+        r'^[cC]hange\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+     ]),
+    ('Deprecated', [
+        r'^[dD]epricated\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+     ]),
+    ('Removed', [
+        r'^[rR]emove\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
      ]),
     ('Fix', [
-        r'^:bug\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+        r'^[fF]ix\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+     ]),
+    ('Security', [
+        r'^[sS]ec\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
      ]),
     ('Documentation', [
-        r'^:memo\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+        r'^[dD]oc\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
-     ]),     
-    ('Remove', [
-        r'^:fire\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
      ]),
 
-    ('Other', None ## Match all lines
+
-     ),
+    #('Other', None ## Match all lines
+    # ),
 
 ]
 
@@ -148,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)\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n@]*)(@[a-z]+\s+)*$', r'\4') |
+    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') |
     SetIfEmpty("No commit message.") | ucfirst | final_dot)
 
 

.github/workflows/shellcheck.yml

@@ -0,0 +1,16 @@
+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/*"

.gitignore

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

.pre-commit-config.yaml

@@ -9,3 +9,9 @@ repos:
         - "-i 2" # indent: 0 for tabs (default), >0 for number of spaces
         - "-ci" # switch cases will be indented
         - "-w" # write result to file instead of stdout
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.9
+    hooks:
+    - id: mdformat
+      additional_dependencies:
+      - mdformat-gfm # GitHub Flavored Markdown support

CHANGELOG.md

@@ -1,97 +1,190 @@
 # Changelog
 
 
-## (unreleased)
+## 0.4.0 (2022-11-07)
+
+### Features
+
+* ✨ add support for dynu.com as DynDNS2 provider. [Eduard Veit]
 
 ### Documentation
 
-* :memo: update README.md. [Eduard Veit]
+* 📝 add dynu.com as DynDNS2 provider. [Eduard Veit]
 
-### Other
 
-* :recycle: normalizing pre-commit configuration to a top-level map. [Eduard Veit]
+## 0.3.5 (2022-11-03)
 
-* :recycle: refactorings. [Eduard Veit]
+### Features
 
-* Feature: :sparkles: add pre-commit git hook for shellcheck. [Eduard Veit]
+* ✨ add support for IPv64.net as DynDNS2 provider. [Eduard Veit]
 
-* Refactor: :recycle: remove unused help message. [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
+
+* ✨ enable parameter extensions for `docker run --interactive` [Eduard Veit]
+
+### Changed
+
+* Handle dns server selection. [Eduard Veit]
+
+### Documentation
+
+* 📝 update CHANGELOG.md. [Eduard Veit]
+
+* 📝 document docker parameters. [Eduard Veit]
+
+* 📝 change default dns server setting. [Eduard Veit]
+
+* 📝 update CHANGELOG. [Eduard Veit]
+
+* 📝 update README.md. [Eduard Veit]
 
 
 ## 0.1.2 (2021-04-23)
 
 ### Documentation
 
-* :memo: document environment variables. [Eduard Veit]
+* 📝 document environment variables. [Eduard Veit]
-
-### Other
-
-* :recycle: refactor: method extractions and other beautifications. [Eduard Veit]
 
 
 ## 0.1.1 (2021-04-23)
 
 ### Fix
 
-* :bug: fix loop and error handling in case of connection issues. [Eduard Veit]
+* 🐛 fix loop and error handling in case of connection issues. [Eduard Veit]
 
 
 ## 0.1.0 (2021-04-22)
 
-### New
+### Features
 
-* :sparkles: add Dockerfile. [Eduard Veit]
+* ✨ add Dockerfile. [Eduard Veit]
 
-* :sparkles: add loop mode. [Eduard Veit]
+* ✨ add loop mode. [Eduard Veit]
 
-* :sparkles: add support for Duck DNS as DynDNS2 provider. [Eduard Veit]
+* ✨ add support for Duck DNS as DynDNS2 provider. [Eduard Veit]
 
-* :sparkles: add support for deSEC as DynDNS2 provider. [Eduard Veit]
+* ✨ add support for deSEC as DynDNS2 provider. [Eduard Veit]
 
-* :sparkles: add completion. [Eduard Veit]
+* ✨ add completion. [Eduard Veit]
 
-  :sparkles: add man page
+  ✨ add man page
 
-* :sparkles: replace getopt with argbash. [Eduard Veit]
+* 🔃 replace getopt with argbash. [Eduard Veit]
 
-* :sparkles: add interpretaton of status codes and act accordingly. [Eduard Veit]
+* ✨ add interpretaton of status codes and act accordingly. [Eduard Veit]
 
-* :sparkles: make network interface configurable. [Eduard Veit]
+* ✨ make network interface configurable. [Eduard Veit]
 
-* :sparkles: add DynDNS2 support for dynv6.com. [Eduard Veit]
+* ✨ add DynDNS2 support for dynv6.com. [Eduard Veit]
 
-* :sparkles: add .gitchangelog.rc. [Eduard Veit]
+### Added
 
-* :sparkles: add dynb.sh. [Eduard Veit]
+* 📝 README.md. [Eduard Veit]
+
+* ✨ dynb.sh. [Eduard Veit]
+
+### Changed
+
+* 🔃 rename environment variables. [Eduard Veit]
 
 ### Fix
 
-* :bug: fix sourcing of config file. [Eduard Veit]
+* 🐛 fix error handling. [Eduard Veit]
 
-  :recycle: do some shellcheck fixes
+* 🐛 fix sourcing of config file. [Eduard Veit]
+
+  ♻️ do some shellcheck fixes
 
 ### Documentation
 
-* :memo: document example of an docker-compose.yml file. [Eduard Veit]
+* 📝 document example of an docker-compose.yml file. [Eduard Veit]
 
-* :memo: document loop mode and dig as requirement. [Eduard Veit]
+* 📝 document `loop mode` and mention `dig` as requirement. [Eduard Veit]
 
-* :memo: update example of .env in README.md. [Eduard Veit]
+* 📝 update example of .env in README.md. [Eduard Veit]
 
-* :memo: add CHANGELOG.md. [Eduard Veit]
+* 📝 CHANGELOG.md. [Eduard Veit]
 
-* :memo: add example.env. [Eduard Veit]
+* 📝 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]
 
 

Dockerfile

@@ -1,5 +1,21 @@
 FROM alpine:latest
-RUN apk update && apk add bash curl jq bind-tools
+
+RUN \
+apk update \
+&& \
+apk add \
+bash \
+curl \
+jq \
+bind-tools \
+tzdata
+
 WORKDIR /usr/src/app
+
 COPY . .
-CMD /bin/bash /usr/src/app/dynb.sh
+
+ENTRYPOINT ["/bin/bash", "/usr/src/app/dynb.sh"]
+
+LABEL org.opencontainers.image.source="https://github.com/EV21/dynb"
+LABEL org.opencontainers.image.description="DynB - dynamic DNS update client."
+LABEL org.opencontainers.image.licenses="MIT"

README.md

@@ -1,55 +1,61 @@
 # 🔃 DynB
+
 DynB - dynamic DNS update script, written in bash
 
 IPv4 (A) and IPv6 (AAAA) record updates are supported.
+
 <!-- TOC -->
+
 - [✨ Update Methods](#-update-methods)
-    - [APIs](#apis)
-    - [DynDNS2](#dyndns2)
 - [📦 Requirements](#-requirements)
 - [🚀 Installation](#-installation)
 - [⚙ Configuration](#-configuration)
 - [🏃 Run](#-run)
 - [⏰ Cron](#-cron)
+  - [loop mode](#loop-mode)
+  - [crontab](#crontab)
 - [🐟 docker](#-docker)
+- [environment variables](#environment-variables)
+
 <!-- /TOC -->
 
 ## ✨ Update Methods
+
 The following update methods are currently implemented:
 
-### APIs
+| Provider            | API                   | TTL in seconds | Credentials                                                                                  | own domain via NS record | free (sub-) domain                             |
-
+|---------------------|-----------------------|----------------|----------------------------------------------------------------------------------------------|--------------------------|------------------------------------------------|
-* INWX.com Domrobot JSON-RPC-API  
+| 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             |
-  Limitations:
+| INWX.com            | DynDNS2               | 60             | specific dyndns `username` & `password`                                                      | ✔️                       | ⛔ choose one of your owned domains per account |
-  - minimum TTL is 300 (5 minutes)
+| deSEC.io (dedyn.io) | DynDNS2               | 60             | `token`                                                                                      | ✔️                       | ✔️                                             |
-
+| DuckDNS.org         | DynDNS2               | 60             | `token`                                                                                      | ⛔                        | ✔️                                             |
-### DynDNS2
+| dynv6.com           | DynDNS2               | 60             | `token`                                                                                      | ✔️                       | ✔️                                             |
-
+| ddnss.de            | DynDNS2               | 10             | `update key` as `token`                                                                      | ⛔                        | ✔️                                             |
-* INWX.com  
+| IPv64.net           | DynDNS2               | 60             | `DynDNS Updatehash` as `token`                                                               | ⛔                        | ✔️                                             |
-* deSEC.io (dedyn.io)  
+| dynu.com            | DynDNS2               | 30             | `username` & `password`                                                                      | ✔️                       | ✔️                                             |
-* DuckDNS.org  
-* dynv6.com  
 
 ## 📦 Requirements
 
-* `curl` - The minimum requirement for all API requests.
+- `curl` - The minimum requirement for all API requests.
-* `dig` - You can get it by installing `dnsutils` (debian/ubuntu/ArchLinux), `bind-utils` (CentOS/RHEL), `bind-tools` (Alpine)
+- `dig` - You can get it by installing `dnsutils` (debian/ubuntu/ArchLinux), `bind-utils` (CentOS/RHEL), `bind-tools` (Alpine)
 
 also essential if you are using other APIs:
 
-* `jq` - Command-line JSON processor
+- `jq` - Command-line JSON processor
 
 ## 🚀 Installation
 
 Download the latest release
 
 or simply clone this repo
-```
+
+```shell
 git clone https://github.com/EV21/dynb.git
 ```
 
-If you want to add the script to you PATH, run :point_down:
+If you want to add the script to you PATH, run 👇
-```
+
+```shell
 bash dynb.sh --link
 ```
 
@@ -59,7 +65,8 @@ You can use a config in form of an `.env` file.
 Or you can just use CLI parameters.
 
 Create `.env` in the app root directory or at `~/.local/share/dynb/.env`.
-```
+
+```bash
 DYNB_DYN_DOMAIN=dyndns.example.com
 
 ## service provider could be deSEC, duckdns, dynv6, inwx
@@ -68,7 +75,7 @@ DYNB_SERVICE_PROVIDER=inwx
 ## update method options: domrobot, dyndns
 DYNB_UPDATE_METHOD=domrobot
 
-## ip mode could be either: 4, 6 or dual for dualstack
+## ip mode could be either: 4, 6 or 64 for dualstack
 DYNB_IP_MODE=64
 
 ## If you are using the DomRobot RPC-API enter your credentials for the web interface login here
@@ -81,19 +88,24 @@ DYNB_TOKEN=
 
 ## 🏃 Run
 
-If you have a config file just run :point_down:
+If you have a config file just run 👇
-```
+
+```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 :point_down:
+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 👇
+
+```bash
 dynb --help
 ```
-```
+
+```bash
 dynb --ip-mode dualstack --update-method domrobot --domain dyndns.example.com --username user42 --password SuperSecretPassword
 ```
-```
+
+```bash
 dynb --ip-mode dualstack --update-method dyndns --provider inwx --domain dyndns.example.com --username user42 --password SuperSecretPassword
 ```
 
@@ -107,19 +119,30 @@ Just use the parameter `--interval 60` or the environment variable `DYNB_INTERVA
 
 ### crontab
 
-execute :point_down:
+execute 👇
-```
+
+```bash
 crontab -e
 ```
-then enter :point_down: to run dynb every five minutes.
+
-```
+then add the following line 👇 to run dynb every five minutes.
+
+```bash
 */5 * * * * $HOME/.local/bin/dynb >> $HOME/.local/share/dynb/dynb-cron.log
 ```
+
+alternative with docker and parameters::
+
+```bash
+*/5 * * * * docker run --interactive --tty --rm --network host ev21/dynb:latest --ip-mode 64 --update-method domrobot --domain dyndns.example.com --username user42 --password SuperSecretPassword
+```
+
 Note, cron typically does not use the users PATH variable.
 
 ## 🐟 docker
 
-This is an example of a `docker-compose.yml` file. If you are using IPv6 make sure the routing works properly with your docker container.
+This is an example of a `docker-compose.yml` file. If you are using IPv6 make sure the routing works properly with your docker container. Note: [IPv6 networking](https://docs.docker.com/config/daemon/ipv6/) is only supported on Docker daemons running on Linux hosts.
+
 ```yaml
 version: '3.4'
 
@@ -128,30 +151,40 @@ services:
     image: ev21/dynb
     container_name: dynb
     network_mode: host
-    build:
+    stdin_open: true
-      context: .
+    tty: true
-      dockerfile: ./Dockerfile
     environment:
       - DYNB_DYN_DOMAIN=dyndns.example.com
-      - DYNB_SERVICE_PROVIDER=inwx
+      # Providers: deSec, DuckDNS, dynv6, inwx, ddnss, ipv64
+      - DYNB_SERVICE_PROVIDER=desec
+      # Possible update methods are: dyndns, domrobot
       - 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
-      - DYNB_INTERVAL=60
+      # 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
 ```
+
 ## environment variables
-| variable              | default value   | description                                   |
+
-| --------------------- | --------------- | --------------------------------------------- |
+| variable              | default value   | description                                                                                                    |
-| DYNB_DYN_DOMAIN       | undefined       | required; `dyndns.example.com`                |
+|-----------------------|-----------------|----------------------------------------------------------------------------------------------------------------|
-| DYNB_SERVICE_PROVIDER | undefined       | required; `deSEC`, `duckdns`, `dynv6`, `inwx` |
+| DYNB_DYN_DOMAIN       | undefined       | required; `dyndns.example.com`                                                                                 |
-| DYNB_UPDATE_METHOD    | undefined       | required; `dyndns` or `domrobot` (with inwx)  |
+| DYNB_SERVICE_PROVIDER | undefined       | required; `deSEC`, `duckdns`, `dynv6`, `inwx`, `ddnss`, `ipv64`                                                |
-| DYNB_IP_MODE          | undefined       | required; `4`, `6` or `64` for both           |
+| DYNB_UPDATE_METHOD    | undefined       | required; `dyndns` or `domrobot` (with inwx)                                                                   |
-| DYNB_USERNAME         | undefined       | the requirement depends on your provider and the update method |
+| DYNB_IP_MODE          | undefined       | required; `4`, `6` or `64` for both                                                                            |
-| DYNB_PASSWORD         | undefined       | the requirement depends on your provider and the update method |
+| DYNB_USERNAME         | undefined       | the requirement depends on your provider and the update method                                                 |
-| DYNB_TOKEN            | undefined       | the requirement depends on your provider and the update method |
+| DYNB_PASSWORD         | undefined       | the requirement depends on your provider and the update method                                                 |
-| DYNB_INTERVAL         | undefined       | without this setting the script/docker container will run one time and exits |
+| DYNB_TOKEN            | undefined       | the requirement depends on your provider and the update method                                                 |
-| DYNB_DEBUG            | undefined       | more console outputs |
+| DYNB_INTERVAL         | undefined       | without this setting the script/docker container will run one time and exits                                   |
-| DYNB_IPv4_CHECK_SITE  | api64.ipify.org | You need a website or Web-API that outputs your remote IP |
+| DYNB_DEBUG            | undefined       | more console outputs                                                                                           |
-| DYNB_IPv6_CHECK_SITE  | api64.ipify.org | You need a website or Web-API that outputs your remote IP |
+| DYNB_IPv4_CHECK_SITE  | api64.ipify.org | You need a website or Web-API that outputs your remote IP                                                      |
+| DYNB_IPv6_CHECK_SITE  | api64.ipify.org | You need a website or Web-API that outputs your remote IP                                                      |
 | DYNB_DNS_CHECK_SERVER | undefined       | If you are using a local DNS Resolver/Server make sure it answers with the public answer or set another server |