📝 document environment variables

♻️ refactor: method extractions and other beautifications
🐛 fix loop and error handling in case of connection issues
2025-12-26 16:39:32 +01:00 · 2021-04-23 18:08:44 +02:00 · 2021-04-23 18:02:16 +02:00 · 2021-04-23 12:00:35 +02:00 · 2021-04-22 22:30:08 +02:00 · 2021-04-22 22:17:49 +02:00
10 changed files with 747 additions and 1422 deletions
--- a/.gitchangelog.rc
+++ b/.gitchangelog.rc
@@ -82,34 +82,24 @@ ignore_regexps = [
 ## whenever you are tweaking this variable.
 ##
 section_regexps = [
-    ('Features', [
-        r'^[fF]eat\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
+    ('New', [
+        r'^:sparkles\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
     ]),
-    ('Added', [
-        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]*)$',
+    ('Changes', [
+        r'^:wrench\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
     ]),
    ('Fix', [
-        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]*)$',
+        r'^:bug\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
     ]),
    ('Documentation', [
-        r'^[dD]oc\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',
-     ]),
+        r'^:memo\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
+     ),

 ]

@@ -158,7 +148,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)


--- a/.github/workflows/shellcheck.yml
+++ b/.github/workflows/shellcheck.yml
@@ -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/*"
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,2 @@
 .env*
 docker-compose*
-.vscode
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,17 +0,0 @@
-repos:
-  - repo: https://github.com/syntaqx/git-hooks
-    rev: v0.0.17
-    hooks:
-    - id: shellcheck
-    - id: shfmt
-      args: 
-        - "-l" # list files whose formatting differs from shfmt's
-        - "-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
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,214 +1,80 @@
 # Changelog


-## 0.5.1 (2022-11-21)
-
-### Features
-
-* Use provider checkip API. [Eduard Veit]
-
-### Fix
-
-* Handle some curl exit codes. [Eduard Veit]
-
-
-## 0.5.0 (2022-11-10)
-
-### Features
-
-* Use provider DNS servers. [Eduard Veit]
-
-* Temporarily disable an ip version if the connectivity/routing does not work. [Eduard Veit]
-
-### Documentation
-
-* 📝 update default values in table. [Eduard Veit]
-
-
-## 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
-
-* ✨ 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

-* 📝 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]


--- a/20
+++ b/20
@@ -1,21 +1,5 @@
 FROM alpine:latest
-
-RUN \
-apk update \
-&& \
-apk add \
-bash \
-curl \
-jq \
-bind-tools \
-tzdata
-
+RUN apk update && apk add bash curl jq bind-tools
 WORKDIR /usr/src/app
-
 COPY . .
-
-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"
+CMD /bin/bash /usr/src/app/dynb.sh
--- a/README.md
+++ b/README.md
@@ -1,61 +1,55 @@
 # 🔃 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:

-| 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

- `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)
+* `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)

 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 👇
-
-```shell
+If you want to add the script to you PATH, run :point_down:
+```
 bash dynb.sh --link
 ```

@@ -65,8 +59,7 @@ 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
@@ -75,7 +68,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,24 +81,19 @@ DYNB_TOKEN=

 ## 🏃 Run

-If you have a config file just run 👇
-
-```bash
+If you have a config file just run :point_down:
+```
 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 👇
-
-```bash
+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:
+```
 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
 ```

@@ -119,30 +107,19 @@ Just use the parameter `--interval 60` or the environment variable `DYNB_INTERVA

 ### crontab

-execute 👇
-
-```bash
+execute :point_down:
+```
 crontab -e
 ```
-
-then add the following line 👇 to run dynb every five minutes.
-
-```bash
+then enter :point_down: to run dynb every five minutes.
+```
 */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. Note: [IPv6 networking](https://docs.docker.com/config/daemon/ipv6/) is only supported on Docker daemons running on Linux hosts.
-
+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.
 ```yaml
 version: '3.4'

@@ -151,40 +128,30 @@ 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_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                                                 |
-| DYNB_PASSWORD         | 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_INTERVAL         | undefined                                                                                                                      | without this setting the script/docker container will run one time and exits                                   |
-| DYNB_DEBUG            | undefined                                                                                                                      | more console outputs                                                                                           |
-| DYNB_IPv4_CHECK_SITE  | tries in this order `ip64.ev21.de` (anonymous logging for 7 days), `api64.ipify.org`, `api.my-ip.io/ip`, `ip.anysrc.net/plain` | You need a website or Web-API that outputs your remote IP                                                      |
-| DYNB_IPv6_CHECK_SITE  | tries in this order `ip64.ev21.de` (anonymous logging for 7 days), `api64.ipify.org`, `api.my-ip.io/ip`, `ip.anysrc.net/plain` | You need a website or Web-API that outputs your remote IP                                                      |
-| DYNB_DNS_CHECK_SERVER | using the DynDNS2 providers DNS servers                                                                                        | If you are using a local DNS Resolver/Server make sure it answers with the public answer or set another server |
+| variable              | default value   | description |
+| --------------------- | --------------- | ----------- |
+| DYNB_DYN_DOMAIN       | undefined       | required |
+| DYNB_SERVICE_PROVIDER | undefined       | required |
+| DYNB_UPDATE_METHOD    | undefined       | required |
+| DYNB_IP_MODE          | undefined       | required |
+| DYNB_USERNAME         | 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_TOKEN            | 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_DEBUG            | undefined       | more console outputs |
+| 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 | 1.1.1.1         | If you are using a local DNS Resolver/Server make sure it answers with the public answer |
--- a/dynb-parsing-template.m4
+++ b/dynb-parsing-template.m4
@@ -1,24 +0,0 @@
-#!/bin/bash
-
-# m4_ignore(
-echo "This is just a script template for argbash, not the script." >&2
-exit 11  #)Created by argbash-init v2.10.0
-# Rearrange the order of options below according to what you would like to see in the help message.
-# ARG_OPTIONAL_BOOLEAN([version],[v],[outputs the client version],[off])
-# ARG_OPTIONAL_BOOLEAN([link],[l],[links to your script at ~/.local/bin/dynb],[off])
-# ARG_OPTIONAL_BOOLEAN([reset],[r],[deletes the client blocking status file],[off])
-# ARG_OPTIONAL_BOOLEAN([debug],[],[enables debug mode],[off])
-# ARG_OPTIONAL_SINGLE([update-method],[m],[choose if you want to use DynDNS2 or the DomRobot RPC-API],[])
-# ARG_OPTIONAL_SINGLE([ip-mode],[i],[updates type A (IPv4) and AAAA (IPv6) records],[])
-# ARG_OPTIONAL_SINGLE([domain],[d],[set the domain you want to update],[])
-# ARG_OPTIONAL_SINGLE([service-provider],[s],[set your provider in case you are using DynDNS2],[])
-# ARG_OPTIONAL_SINGLE([username],[u],[depends on your selected update method and your provider],[])
-# ARG_OPTIONAL_SINGLE([password],[p],[depends on your selected update method and your provider],[])
-# ARG_OPTIONAL_SINGLE([token],[t],[depends on your selected update method and your provider],[])
-# ARG_OPTIONAL_SINGLE([interval],[],[choose the seconds interval to run the script in a loop, minimum is 60],[])
-# ARG_HELP([DynB - dynamic DNS update script for bash])
-# ARGBASH_GO
-
-# [ <-- needed because of Argbash
-
-# ] <-- needed because of Argbash
--- a/dynb-parsing.sh
+++ b/dynb-parsing.sh
@@ -1,297 +0,0 @@
-#!/bin/bash
-
-# Created by argbash-init v2.10.0
-# Rearrange the order of options below according to what you would like to see in the help message.
-# ARG_OPTIONAL_BOOLEAN([version],[v],[outputs the client version],[off])
-# ARG_OPTIONAL_BOOLEAN([link],[l],[links to your script at ~/.local/bin/dynb],[off])
-# ARG_OPTIONAL_BOOLEAN([reset],[r],[deletes the client blocking status file],[off])
-# ARG_OPTIONAL_BOOLEAN([debug],[],[enables debug mode],[off])
-# ARG_OPTIONAL_SINGLE([update-method],[m],[choose if you want to use DynDNS2 or the DomRobot RPC-API],[])
-# ARG_OPTIONAL_SINGLE([ip-mode],[i],[updates type A (IPv4) and AAAA (IPv6) records],[])
-# ARG_OPTIONAL_SINGLE([domain],[d],[set the domain you want to update],[])
-# ARG_OPTIONAL_SINGLE([service-provider],[s],[set your provider in case you are using DynDNS2],[])
-# ARG_OPTIONAL_SINGLE([username],[u],[depends on your selected update method and your provider],[])
-# ARG_OPTIONAL_SINGLE([password],[p],[depends on your selected update method and your provider],[])
-# ARG_OPTIONAL_SINGLE([token],[t],[depends on your selected update method and your provider],[])
-# ARG_OPTIONAL_SINGLE([interval],[],[choose the seconds interval to run the script in a loop, minimum is 60],[])
-# ARG_HELP([DynB - dynamic DNS update script for bash])
-# ARGBASH_GO()
-# needed because of Argbash --> m4_ignore([
-### START OF CODE GENERATED BY Argbash v2.10.0 one line above ###
-# Argbash is a bash code generator used to get arguments parsing right.
-# Argbash is FREE SOFTWARE, see https://argbash.io for more info
-
-
-# # When called, the process ends.
-# Args:
-# 	$1: The exit message (print to stderr)
-# 	$2: The exit code (default is 1)
-# if env var _PRINT_HELP is set to 'yes', the usage is print to stderr (prior to $1)
-# Example:
-# 	test -f "$_arg_infile" || _PRINT_HELP=yes die "Can't continue, have to supply file as an argument, got '$_arg_infile'" 4
-die()
-{
-	local _ret="${2:-1}"
-	test "${_PRINT_HELP:-no}" = yes && print_help >&2
-	echo "$1" >&2
-	exit "${_ret}"
-}
-
-
-# Function that evaluates whether a value passed to it begins by a character
-# that is a short option of an argument the script knows about.
-# This is required in order to support getopts-like short options grouping.
-begins_with_short_option()
-{
-	local first_option all_short_options='vlrmidsupth'
-	first_option="${1:0:1}"
-	test "$all_short_options" = "${all_short_options/$first_option/}" && return 1 || return 0
-}
-
-# THE DEFAULTS INITIALIZATION - OPTIONALS
-_arg_version="off"
-_arg_link="off"
-_arg_reset="off"
-_arg_debug="off"
-_arg_update_method=
-_arg_ip_mode=
-_arg_domain=
-_arg_service_provider=
-_arg_username=
-_arg_password=
-_arg_token=
-_arg_interval=
-
-
-# Function that prints general usage of the script.
-# This is useful if users asks for it, or if there is an argument parsing error (unexpected / spurious arguments)
-# and it makes sense to remind the user how the script is supposed to be called.
-print_help()
-{
-	printf '%s\n' "DynB - dynamic DNS update script for bash"
-	printf 'Usage: %s [-v|--(no-)version] [-l|--(no-)link] [-r|--(no-)reset] [--(no-)debug] [-m|--update-method <arg>] [-i|--ip-mode <arg>] [-d|--domain <arg>] [-s|--service-provider <arg>] [-u|--username <arg>] [-p|--password <arg>] [-t|--token <arg>] [--interval <arg>] [-h|--help]\n' "$0"
-	printf '\t%s\n' "-v, --version, --no-version: outputs the client version (off by default)"
-	printf '\t%s\n' "-l, --link, --no-link: links to your script at ~/.local/bin/dynb (off by default)"
-	printf '\t%s\n' "-r, --reset, --no-reset: deletes the client blocking status file (off by default)"
-	printf '\t%s\n' "--debug, --no-debug: enables debug mode (off by default)"
-	printf '\t%s\n' "-m, --update-method: choose if you want to use DynDNS2 or the DomRobot RPC-API (no default)"
-	printf '\t%s\n' "-i, --ip-mode: updates type A (IPv4) and AAAA (IPv6) records (no default)"
-	printf '\t%s\n' "-d, --domain: set the domain you want to update (no default)"
-	printf '\t%s\n' "-s, --service-provider: set your provider in case you are using DynDNS2 (no default)"
-	printf '\t%s\n' "-u, --username: depends on your selected update method and your provider (no default)"
-	printf '\t%s\n' "-p, --password: depends on your selected update method and your provider (no default)"
-	printf '\t%s\n' "-t, --token: depends on your selected update method and your provider (no default)"
-	printf '\t%s\n' "--interval: choose the seconds interval to run the script in a loop, minimum is 60 (no default)"
-	printf '\t%s\n' "-h, --help: Prints help"
-}
-
-
-# The parsing of the command-line
-parse_commandline()
-{
-	while test $# -gt 0
-	do
-		_key="$1"
-		case "$_key" in
-			# The version argurment doesn't accept a value,
-			# we expect the --version or -v, so we watch for them.
-			-v|--no-version|--version)
-				_arg_version="on"
-				test "${1:0:5}" = "--no-" && _arg_version="off"
-				;;
-			# We support getopts-style short arguments clustering,
-			# so as -v doesn't accept value, other short options may be appended to it, so we watch for -v*.
-			# After stripping the leading -v from the argument, we have to make sure
-			# that the first character that follows coresponds to a short option.
-			-v*)
-				_arg_version="on"
-				_next="${_key##-v}"
-				if test -n "$_next" -a "$_next" != "$_key"
-				then
-					{ begins_with_short_option "$_next" && shift && set -- "-v" "-${_next}" "$@"; } || die "The short option '$_key' can't be decomposed to ${_key:0:2} and -${_key:2}, because ${_key:0:2} doesn't accept value and '-${_key:2:1}' doesn't correspond to a short option."
-				fi
-				;;
-			# See the comment of option '--version' to see what's going on here - principle is the same.
-			-l|--no-link|--link)
-				_arg_link="on"
-				test "${1:0:5}" = "--no-" && _arg_link="off"
-				;;
-			# See the comment of option '-v' to see what's going on here - principle is the same.
-			-l*)
-				_arg_link="on"
-				_next="${_key##-l}"
-				if test -n "$_next" -a "$_next" != "$_key"
-				then
-					{ begins_with_short_option "$_next" && shift && set -- "-l" "-${_next}" "$@"; } || die "The short option '$_key' can't be decomposed to ${_key:0:2} and -${_key:2}, because ${_key:0:2} doesn't accept value and '-${_key:2:1}' doesn't correspond to a short option."
-				fi
-				;;
-			# See the comment of option '--version' to see what's going on here - principle is the same.
-			-r|--no-reset|--reset)
-				_arg_reset="on"
-				test "${1:0:5}" = "--no-" && _arg_reset="off"
-				;;
-			# See the comment of option '-v' to see what's going on here - principle is the same.
-			-r*)
-				_arg_reset="on"
-				_next="${_key##-r}"
-				if test -n "$_next" -a "$_next" != "$_key"
-				then
-					{ begins_with_short_option "$_next" && shift && set -- "-r" "-${_next}" "$@"; } || die "The short option '$_key' can't be decomposed to ${_key:0:2} and -${_key:2}, because ${_key:0:2} doesn't accept value and '-${_key:2:1}' doesn't correspond to a short option."
-				fi
-				;;
-			# See the comment of option '--version' to see what's going on here - principle is the same.
-			--no-debug|--debug)
-				_arg_debug="on"
-				test "${1:0:5}" = "--no-" && _arg_debug="off"
-				;;
-			# We support whitespace as a delimiter between option argument and its value.
-			# Therefore, we expect the --update-method or -m value.
-			# so we watch for --update-method and -m.
-			# Since we know that we got the long or short option,
-			# we just reach out for the next argument to get the value.
-			-m|--update-method)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_update_method="$2"
-				shift
-				;;
-			# We support the = as a delimiter between option argument and its value.
-			# Therefore, we expect --update-method=value, so we watch for --update-method=*
-			# For whatever we get, we strip '--update-method=' using the ${var##--update-method=} notation
-			# to get the argument value
-			--update-method=*)
-				_arg_update_method="${_key##--update-method=}"
-				;;
-			# We support getopts-style short arguments grouping,
-			# so as -m accepts value, we allow it to be appended to it, so we watch for -m*
-			# and we strip the leading -m from the argument string using the ${var##-m} notation.
-			-m*)
-				_arg_update_method="${_key##-m}"
-				;;
-			# See the comment of option '--update-method' to see what's going on here - principle is the same.
-			-i|--ip-mode)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_ip_mode="$2"
-				shift
-				;;
-			# See the comment of option '--update-method=' to see what's going on here - principle is the same.
-			--ip-mode=*)
-				_arg_ip_mode="${_key##--ip-mode=}"
-				;;
-			# See the comment of option '-m' to see what's going on here - principle is the same.
-			-i*)
-				_arg_ip_mode="${_key##-i}"
-				;;
-			# See the comment of option '--update-method' to see what's going on here - principle is the same.
-			-d|--domain)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_domain="$2"
-				shift
-				;;
-			# See the comment of option '--update-method=' to see what's going on here - principle is the same.
-			--domain=*)
-				_arg_domain="${_key##--domain=}"
-				;;
-			# See the comment of option '-m' to see what's going on here - principle is the same.
-			-d*)
-				_arg_domain="${_key##-d}"
-				;;
-			# See the comment of option '--update-method' to see what's going on here - principle is the same.
-			-s|--service-provider)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_service_provider="$2"
-				shift
-				;;
-			# See the comment of option '--update-method=' to see what's going on here - principle is the same.
-			--service-provider=*)
-				_arg_service_provider="${_key##--service-provider=}"
-				;;
-			# See the comment of option '-m' to see what's going on here - principle is the same.
-			-s*)
-				_arg_service_provider="${_key##-s}"
-				;;
-			# See the comment of option '--update-method' to see what's going on here - principle is the same.
-			-u|--username)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_username="$2"
-				shift
-				;;
-			# See the comment of option '--update-method=' to see what's going on here - principle is the same.
-			--username=*)
-				_arg_username="${_key##--username=}"
-				;;
-			# See the comment of option '-m' to see what's going on here - principle is the same.
-			-u*)
-				_arg_username="${_key##-u}"
-				;;
-			# See the comment of option '--update-method' to see what's going on here - principle is the same.
-			-p|--password)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_password="$2"
-				shift
-				;;
-			# See the comment of option '--update-method=' to see what's going on here - principle is the same.
-			--password=*)
-				_arg_password="${_key##--password=}"
-				;;
-			# See the comment of option '-m' to see what's going on here - principle is the same.
-			-p*)
-				_arg_password="${_key##-p}"
-				;;
-			# See the comment of option '--update-method' to see what's going on here - principle is the same.
-			-t|--token)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_token="$2"
-				shift
-				;;
-			# See the comment of option '--update-method=' to see what's going on here - principle is the same.
-			--token=*)
-				_arg_token="${_key##--token=}"
-				;;
-			# See the comment of option '-m' to see what's going on here - principle is the same.
-			-t*)
-				_arg_token="${_key##-t}"
-				;;
-			# See the comment of option '--update-method' to see what's going on here - principle is the same.
-			--interval)
-				test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
-				_arg_interval="$2"
-				shift
-				;;
-			# See the comment of option '--update-method=' to see what's going on here - principle is the same.
-			--interval=*)
-				_arg_interval="${_key##--interval=}"
-				;;
-			# See the comment of option '--version' to see what's going on here - principle is the same.
-			-h|--help)
-				print_help
-				exit 0
-				;;
-			# See the comment of option '-v' to see what's going on here - principle is the same.
-			-h*)
-				print_help
-				exit 0
-				;;
-			*)
-				_PRINT_HELP=yes die "FATAL ERROR: Got an unexpected argument '$1'" 1
-				;;
-		esac
-		shift
-	done
-}
-
-# Now call all the functions defined above that are needed to get the job done
-parse_commandline "$@"
-
-# OTHER STUFF GENERATED BY Argbash
-
-### END OF CODE GENERATED BY Argbash (sortof) ### ])
-# [ <-- needed because of Argbash
-
-
-# vvv  PLACE YOUR CODE HERE  vvv
-
-# PUT YOUR CODE HERE
-
-# ^^^  TERMINATE YOUR CODE BEFORE THE BOTTOM ARGBASH MARKER  ^^^
-
-# ] <-- needed because of Argbash
--- a/dynb.sh
+++ b/dynb.sh
Author	SHA1	Message	Date
Eduard Veit	4e26ff135d	📝 document environment variables	2021-04-23 18:08:44 +02:00
Eduard Veit	be2f4f3862	♻️ refactor: method extractions and other beautifications	2021-04-23 18:02:16 +02:00
Eduard Veit	93c1ed18d0	🐛 fix loop and error handling in case of connection issues	2021-04-23 12:00:35 +02:00
Eduard Veit	2c23b1de6e	📝 document example of an docker-compose.yml file	2021-04-22 22:30:08 +02:00
Eduard Veit	f9507929da	✨ add Dockerfile	2021-04-22 22:17:49 +02:00
Eduard Veit	30e77c9722	📝 document loop mode and dig as requirement	2021-04-22 22:10:11 +02:00
Eduard Veit	bb1d514b50	✨ add loop mode	2021-04-22 21:55:25 +02:00
Eduard Veit	c02dc68f17	📝 update example of .env in README.md	2021-04-21 13:45:45 +02:00
Eduard Veit	dcf9f1e7a2	♻️ refactor: rename environment variables	2021-04-21 13:04:59 +02:00
Eduard Veit	4d28f55ce9	✨ add support for Duck DNS as DynDNS2 provider	2021-04-04 16:31:42 +02:00
Eduard Veit	b8565eb38f	✨ add support for deSEC as DynDNS2 provider	2021-04-04 11:24:13 +02:00
Eduard Veit	ab330e9731	✨ add completion ✨ add man page	2021-04-03 17:35:26 +02:00
Eduard Veit	262f7c3709	✨ replace getopt with argbash	2021-04-03 14:06:03 +02:00
Eduard Veit	5210c35400	♻️ refactor, fix and debug error handling	2021-01-27 17:52:15 +01:00
Eduard Veit	522a0f99bb	♻️ refactor main code	2021-01-26 22:23:03 +01:00
Eduard Veit	3bf6b69ae8	✨ add interpretaton of status codes and act accordingly	2021-01-26 21:43:07 +01:00
Eduard Veit	d139022295	✨ make network interface configurable	2021-01-26 21:43:07 +01:00
Eduard Veit	8997835903	🐛 fix sourcing of config file ♻️ do some shellcheck fixes	2021-01-26 21:43:07 +01:00
Eduard Veit	d6dc223794	✨ add DynDNS2 support for dynv6.com	2021-01-26 21:43:07 +01:00
Eduard Veit	dc12f71d00	📝 add CHANGELOG.md	2021-01-26 21:43:07 +01:00
Eduard Veit	5ba730cff1	✨ add .gitchangelog.rc	2021-01-26 21:43:07 +01:00
Eduard Veit	1104cf8505	📝 add example.env	2021-01-26 21:43:07 +01:00
Eduard Veit	99a446f4c7	📝 write README.md	2021-01-26 21:42:21 +01:00
Eduard Veit	f056e96e25	✨ add dynb.sh	2021-01-26 21:24:33 +01:00