mirror of
https://github.com/EV21/dynb.git
synced 2025-12-26 16:39:32 +01:00
Compare commits
28 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
ba6e91bbd6
|
|||
|
756c17d117
|
|||
|
3d1b27aaed
|
|||
|
8721af229d
|
|||
|
c712ec5654
|
|||
|
9cc26d737f
|
|||
|
e6af29dcd4
|
|||
|
b3eb045cc7
|
|||
|
4b68ca837d
|
|||
|
eedb0623ac
|
|||
|
b5d300a86e
|
|||
|
a95effb00d
|
|||
|
a5dc7ea9b3
|
|||
|
63cbce3568
|
|||
|
73d2a7ac44
|
|||
|
cad6d47cd2
|
|||
|
06c35d99af
|
|||
|
9da624b163
|
|||
|
c01bea615e
|
|||
|
046a728f22
|
|||
|
3ded7fc883
|
|||
|
f942a4495d
|
|||
|
32404f2957
|
|||
|
3cdcdbc8bf
|
|||
|
226537b2b0
|
|||
|
976ea673f8
|
|||
|
9ed30f2bee
|
|||
|
3ab88e5993
|
@@ -82,24 +82,34 @@ ignore_regexps = [
|
|||||||
## whenever you are tweaking this variable.
|
## whenever you are tweaking this variable.
|
||||||
##
|
##
|
||||||
section_regexps = [
|
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', [
|
('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', [
|
('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.
|
## Available constructs are those listed in ``body_process`` doc.
|
||||||
subject_process = (strip |
|
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)
|
SetIfEmpty("No commit message.") | ucfirst | final_dot)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
16
.github/workflows/shellcheck.yml
vendored
Normal file
16
.github/workflows/shellcheck.yml
vendored
Normal file
@@ -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/*"
|
||||||
17
.pre-commit-config.yaml
Normal file
17
.pre-commit-config.yaml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
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
|
||||||
47
CHANGELOG.md
47
CHANGELOG.md
@@ -1,6 +1,53 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
|
||||||
|
## 0.2.0 (2021-09-24)
|
||||||
|
|
||||||
|
### New
|
||||||
|
|
||||||
|
* :sparkles: enable parameter extensions for `docker run --interactive` [Eduard Veit]
|
||||||
|
|
||||||
|
* :sparkles: add pre-commit hooks for markdown. [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
|
||||||
|
|
||||||
|
* :memo: update CHANGELOG.md. [Eduard Veit]
|
||||||
|
|
||||||
|
* :memo: document docker parameters. [Eduard Veit]
|
||||||
|
|
||||||
|
* :memo: change default dns server setting. [Eduard Veit]
|
||||||
|
|
||||||
|
* :memo: update CHANGELOG. [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)
|
## 0.1.2 (2021-04-23)
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|||||||
19
Dockerfile
19
Dockerfile
@@ -1,5 +1,20 @@
|
|||||||
FROM alpine:latest
|
FROM alpine:latest
|
||||||
RUN apk update && apk add bash curl jq bind-tools
|
|
||||||
|
RUN \
|
||||||
|
apk update \
|
||||||
|
&& \
|
||||||
|
apk add \
|
||||||
|
bash \
|
||||||
|
curl \
|
||||||
|
jq \
|
||||||
|
bind-tools
|
||||||
|
|
||||||
WORKDIR /usr/src/app
|
WORKDIR /usr/src/app
|
||||||
|
|
||||||
COPY . .
|
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"
|
||||||
|
|||||||
79
README.md
79
README.md
@@ -1,8 +1,11 @@
|
|||||||
# 🔃 DynB
|
# 🔃 DynB
|
||||||
|
|
||||||
DynB - dynamic DNS update script, written in bash
|
DynB - dynamic DNS update script, written in bash
|
||||||
|
|
||||||
IPv4 (A) and IPv6 (AAAA) record updates are supported.
|
IPv4 (A) and IPv6 (AAAA) record updates are supported.
|
||||||
|
|
||||||
<!-- TOC -->
|
<!-- TOC -->
|
||||||
|
|
||||||
- [✨ Update Methods](#-update-methods)
|
- [✨ Update Methods](#-update-methods)
|
||||||
- [APIs](#apis)
|
- [APIs](#apis)
|
||||||
- [DynDNS2](#dyndns2)
|
- [DynDNS2](#dyndns2)
|
||||||
@@ -11,45 +14,52 @@ IPv4 (A) and IPv6 (AAAA) record updates are supported.
|
|||||||
- [⚙ Configuration](#-configuration)
|
- [⚙ Configuration](#-configuration)
|
||||||
- [🏃 Run](#-run)
|
- [🏃 Run](#-run)
|
||||||
- [⏰ Cron](#-cron)
|
- [⏰ Cron](#-cron)
|
||||||
|
- [loop mode](#loop-mode)
|
||||||
|
- [crontab](#crontab)
|
||||||
- [🐟 docker](#-docker)
|
- [🐟 docker](#-docker)
|
||||||
|
- [environment variables](#environment-variables)
|
||||||
|
|
||||||
<!-- /TOC -->
|
<!-- /TOC -->
|
||||||
|
|
||||||
## ✨ Update Methods
|
## ✨ Update Methods
|
||||||
|
|
||||||
The following update methods are currently implemented:
|
The following update methods are currently implemented:
|
||||||
|
|
||||||
### APIs
|
### APIs
|
||||||
|
|
||||||
* INWX.com Domrobot JSON-RPC-API
|
- INWX.com Domrobot JSON-RPC-API\
|
||||||
Limitations:
|
Limitations:
|
||||||
- minimum TTL is 300 (5 minutes)
|
- minimum TTL is 300 (5 minutes)
|
||||||
|
|
||||||
### DynDNS2
|
### DynDNS2
|
||||||
|
|
||||||
* INWX.com
|
- INWX.com
|
||||||
* deSEC.io (dedyn.io)
|
- deSEC.io (dedyn.io)
|
||||||
* DuckDNS.org
|
- DuckDNS.org
|
||||||
* dynv6.com
|
- dynv6.com
|
||||||
|
|
||||||
## 📦 Requirements
|
## 📦 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:
|
also essential if you are using other APIs:
|
||||||
|
|
||||||
* `jq` - Command-line JSON processor
|
- `jq` - Command-line JSON processor
|
||||||
|
|
||||||
## 🚀 Installation
|
## 🚀 Installation
|
||||||
|
|
||||||
Download the latest release
|
Download the latest release
|
||||||
|
|
||||||
or simply clone this repo
|
or simply clone this repo
|
||||||
```
|
|
||||||
|
```shell
|
||||||
git clone https://github.com/EV21/dynb.git
|
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 :point_down:
|
||||||
```
|
|
||||||
|
```shell
|
||||||
bash dynb.sh --link
|
bash dynb.sh --link
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -59,7 +69,8 @@ You can use a config in form of an `.env` file.
|
|||||||
Or you can just use CLI parameters.
|
Or you can just use CLI parameters.
|
||||||
|
|
||||||
Create `.env` in the app root directory or at `~/.local/share/dynb/.env`.
|
Create `.env` in the app root directory or at `~/.local/share/dynb/.env`.
|
||||||
```
|
|
||||||
|
```bash
|
||||||
DYNB_DYN_DOMAIN=dyndns.example.com
|
DYNB_DYN_DOMAIN=dyndns.example.com
|
||||||
|
|
||||||
## service provider could be deSEC, duckdns, dynv6, inwx
|
## service provider could be deSEC, duckdns, dynv6, inwx
|
||||||
@@ -82,18 +93,23 @@ DYNB_TOKEN=
|
|||||||
## 🏃 Run
|
## 🏃 Run
|
||||||
|
|
||||||
If you have a config file just run :point_down:
|
If you have a config file just run :point_down:
|
||||||
```
|
|
||||||
|
```bash
|
||||||
dynb
|
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.
|
|
||||||
|
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:
|
Call the help function :point_down:
|
||||||
```
|
|
||||||
|
```bash
|
||||||
dynb --help
|
dynb --help
|
||||||
```
|
```
|
||||||
```
|
|
||||||
|
```bash
|
||||||
dynb --ip-mode dualstack --update-method domrobot --domain dyndns.example.com --username user42 --password SuperSecretPassword
|
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
|
dynb --ip-mode dualstack --update-method dyndns --provider inwx --domain dyndns.example.com --username user42 --password SuperSecretPassword
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -108,18 +124,29 @@ Just use the parameter `--interval 60` or the environment variable `DYNB_INTERVA
|
|||||||
### crontab
|
### crontab
|
||||||
|
|
||||||
execute :point_down:
|
execute :point_down:
|
||||||
```
|
|
||||||
|
```bash
|
||||||
crontab -e
|
crontab -e
|
||||||
```
|
```
|
||||||
|
|
||||||
then enter :point_down: 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
|
*/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.
|
Note, cron typically does not use the users PATH variable.
|
||||||
|
|
||||||
## 🐟 docker
|
## 🐟 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
|
```yaml
|
||||||
version: '3.4'
|
version: '3.4'
|
||||||
|
|
||||||
@@ -140,13 +167,15 @@ services:
|
|||||||
- DYNB_PASSWORD=SuperSecretPassword
|
- DYNB_PASSWORD=SuperSecretPassword
|
||||||
- DYNB_INTERVAL=60
|
- DYNB_INTERVAL=60
|
||||||
```
|
```
|
||||||
|
|
||||||
## environment variables
|
## environment variables
|
||||||
|
|
||||||
| variable | default value | description |
|
| variable | default value | description |
|
||||||
| --------------------- | --------------- | ----------- |
|
| --------------------- | --------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
| DYNB_DYN_DOMAIN | undefined | required |
|
| DYNB_DYN_DOMAIN | undefined | required; `dyndns.example.com` |
|
||||||
| DYNB_SERVICE_PROVIDER | undefined | required |
|
| DYNB_SERVICE_PROVIDER | undefined | required; `deSEC`, `duckdns`, `dynv6`, `inwx` |
|
||||||
| DYNB_UPDATE_METHOD | undefined | required |
|
| DYNB_UPDATE_METHOD | undefined | required; `dyndns` or `domrobot` (with inwx) |
|
||||||
| DYNB_IP_MODE | undefined | required |
|
| 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_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_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_TOKEN | undefined | the requirement depends on your provider and the update method |
|
||||||
@@ -154,4 +183,4 @@ services:
|
|||||||
| DYNB_DEBUG | undefined | more console outputs |
|
| 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_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_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 |
|
| 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 |
|
||||||
|
|||||||
24
dynb-parsing-template.m4
Normal file
24
dynb-parsing-template.m4
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
#!/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
|
||||||
297
dynb-parsing.sh
Normal file
297
dynb-parsing.sh
Normal file
@@ -0,0 +1,297 @@
|
|||||||
|
#!/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
|
||||||
Reference in New Issue
Block a user