📝 document example of an docker-compose.yml file

✨ add man page

CHANGELOG.md

@@ -1,24 +1,6 @@
 # Changelog
 
 
-## 0.1.2 (2021-04-23)
-
-### Documentation
-
-* :memo: 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]
-
-
 ## 0.1.0 (2021-04-22)
 
 ### New

README.md

@@ -11,7 +11,7 @@ IPv4 (A) and IPv6 (AAAA) record updates are supported.
 - [⚙ Configuration](#-configuration)
 - [🏃 Run](#-run)
 - [⏰ Cron](#-cron)
-- [🐟 docker](#-docker)
+- [⏰ docker](#-docker)
 <!-- /TOC -->
 
 ## ✨ Update Methods
@@ -140,18 +140,3 @@ services:
       - DYNB_PASSWORD=SuperSecretPassword
       - DYNB_INTERVAL=60
 ```
-## environment variables
-| 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 |

dynb.sh

@@ -65,7 +65,7 @@ _response=
 _statusHostname=
 _statusUsername=
 _statusPassword=
-_version=0.1.2
+_version=0.1.0
 _userAgent="DynB/$_version github.com/EV21/dynb"
 _configFile=$HOME/.local/share/dynb/.env
 _statusFile=/tmp/dynb.status
@@ -345,22 +345,13 @@ function debugMode() {
   fi
 }
 
-function infoMessage() {
-  echo "$(logtime) INFO: $*"
-}
-
 function debugMessage() {
   if debugMode; then
-    echo "$(logtime) DEBUG: $*"
+    echo "Debug: $*"
   fi
 }
 
-function errorMessage() { printf "$(logtime) ERROR: %s\n" "$*" >&2; }
+function echoerr() { printf "%s\n" "$*" >&2; }
-
-function logtime() {
-  LOGTIME=$(date "+%Y-%m-%d %H:%M:%S")
-  echo "[$LOGTIME]"
-}
 
 # The main domain as an identifier for the dns zone is required for the updateRecord call
 function getMainDomain() {
@@ -482,7 +473,7 @@ function dynupdate() {
       myipv6_str=ipv6
     ;;
     * )
-    errorMessage "$DYNB_SERVICE_PROVIDER is not supported"
+    echoerr "$DYNB_SERVICE_PROVIDER is not supported"
     exit 1
     ;;
   esac
@@ -525,64 +516,64 @@ function dynupdate() {
   case $_response in
     good* | OK* | "addresses updated" )
       if [[ $_response == "good 127.0.0.1" ]]; then
-        errorMessage "$_response: Request ignored."
+        echoerr "Error: $_response: Request ignored."
         return 1
       else
-        infoMessage "$_response: The DynDNS update has been executed."
+        echo "$_response: The DynDNS update has been executed."
         _errorCounter=0
         return 0
       fi
     ;;
     nochg* )
-      infoMessage "$_response: Nothing has changed, IP addresses are still up to date."
+      echo "$_response: Nothing has changed, IP addresses are still up to date."
       return 1
     ;;
     abuse )
-      errorMessage "$_response: Username is blocked due to abuse."
+      echoerr "Error: $_response: Username is blocked due to abuse."
       return 1
     ;;
     badauth | 401 )
-      errorMessage "$_response: Invalid username password combination."
+      echoerr "Error: $_response: Invalid username password combination."
       return 1
     ;;
     badagent )
-      errorMessage "$_response: Client disabled. Something is very wrong!"
+      echoerr "Error: $_response: Client disabled. Something is very wrong!"
       return 1
     ;;
     !donator )
-      errorMessage "$_response: An update request was sent, including a feature that is not available to that particular user such as offline options."
+      echoerr "Error: $_response: An update request was sent, including a feature that is not available to that particular user such as offline options."
       return 1
     ;;
     !yours )
-      errorMessage "$_response: The domain does not belong to your user account"
+      echoerr "Error: $_response: The domain does not belong to your user account"
       return 1
     ;;
     notfqdn )
-      errorMessage "$_response: Hostname $DYNB_DYN_DOMAIN is invalid"
+      echoerr "Error: $_response: Hostname $DYNB_DYN_DOMAIN is invalid"
       return 1
     ;;
     nohost )
-      errorMessage "$_response: Hostname supplied does not exist under specified account, enter new login credentials before performing an additional request."
+      echoerr "Error: $_response: Hostname supplied does not exist under specified account, enter new login credentials before performing an additional request."
       return 1
     ;;
     numhost )
-      errorMessage "$_response: Too many hostnames have been specified for this update"
+      echoerr "Error: $_response: Too many hostnames have been specified for this update"
       return 1
     ;;
     dnserr )
-      errorMessage "$_response: There is an internal error in the dyndns update system. Retry update no sooner than 30 minutes."
+      echoerr "Error: $_response: There is an internal error in the dyndns update system. Retry update no sooner than 30 minutes."
       return 1
     ;;
     911 | 5* )
-      errorMessage "$_response: A fatal error on provider side such as a database outage. Retry update no sooner than 30 minutes."
+      echoerr "Error: $_response: A fatal error on provider side such as a database outage. Retry update no sooner than 30 minutes."
       return 1
     ;;
     * )
       if [[ "$_response" == "$_status" ]]; then
-        errorMessage "An unknown response code has been received. $_response"
+        echoerr "Error: An unknown response code has been received. $_response"
         return 1
       else
-        errorMessage "unknown respnse code: $_response"
+        echoerr "Error: unknown respnse code: $_response"
         return 0
       fi
     ;;
@@ -598,14 +589,14 @@ function checkStatus() {
   case $_status in
     nochg* )
       if [[ _errorCounter -gt 1 ]]; then
-        errorMessage "The update client was spamming unnecessary update requests, something might be wrong with your IP-Check site."
+        echoerr "Error: The update client was spamming unnecessary update requests, something might be wrong with your IP-Check site."
-        errorMessage "Fix your config an then delete $_statusFile or restart your docker container"
+        echoerr "Fix your config an then delete $_statusFile"
         return 1
       fi
     ;;
     nohost | !yours )
       if [[ "$_statusHostname" == "$DYNB_DYN_DOMAIN" && ( "$_statusUsername" == "$DYNB_USERNAME" || $_statusUsername == "$DYNB_TOKEN" ) ]]; then
-        errorMessage "Hostname supplied does not exist under specified account, enter new login credentials before performing an additional request."
+        echoerr "Error: Hostname supplied does not exist under specified account, enter new login credentials before performing an additional request."
         return 1
       else
         rm "$_statusFile"
@@ -614,7 +605,7 @@ function checkStatus() {
     ;;
     badauth | 401 )
       if [[ "$_statusUsername" == "$DYNB_USERNAME" && "$_statusPassword" == "$DYNB_PASSWORD" ]]; then
-        errorMessage "Invalid username password combination."
+        echoerr "Error: Invalid username password combination."
         return 1
       else
         rm "$_statusFile"
@@ -622,19 +613,19 @@ function checkStatus() {
       return 0
     ;;
     badagent )
-      errorMessage "Client is deactivated by provider."
+      echoerr "Error: Client is deactivated by provider."
       echo "Fix your config and then manually remove $_statusFile to reset the client blockade."
       echo "If it still fails file an issue at github or try another client :)"
       return 1
     ;;
     !donator )
-      errorMessage "An update request was sent, including a feature that is not available to that particular user such as offline options."
+      echoerr "Error: An update request was sent, including a feature that is not available to that particular user such as offline options."
       echo "Fix your config and then manually remove $_statusFile to reset the client blockade"
       echo "If it still fails file an issue at github or try another client :)"
       return 1
     ;;
     abuse )
-      errorMessage "Username is blocked due to abuse."
+      echoerr "Error: Username is blocked due to abuse."
       echo "Fix your config and then manually remove $_statusFile to reset the client blockade"
       echo "If it still fails file an issue at github or try another client :)"
       return 1
@@ -642,7 +633,7 @@ function checkStatus() {
     911 | 5* )
       delta=$(( $(date +%s) - _eventTime ))
       if [[ $delta -lt 1800 ]]; then
-        errorMessage "$_status: The provider currently has an fatal error. DynB will wait for next update until 30 minutes have passed since last request, $(date --date=@$delta -u +%M) minutes already passed."
+        echoerr "$_status: The provider currently has an fatal error. DynB will wait for next update until 30 minutes have passed since last request, $(date --date=@$delta -u +%M) minutes already passed."
         return 1
       else
         rm "$_statusFile"
@@ -651,7 +642,7 @@ function checkStatus() {
     ;;
     * )
       if [[ _errorCounter -gt 1 ]]; then
-        errorMessage "An unknown response code has repeatedly been received. $_response"
+        echoerr "Error: An unknown response code has repeatedly been received. $_response"
         return 1
       else
         return 0
@@ -665,40 +656,18 @@ function checkStatus() {
 function ipHasChanged() {
   if [[ ${1} == 4 ]]; then
     remote_ip=$(getRemoteIP 4 $_ipv4_checker)
-    #TODO: this is duplicated code, refactor this.
-    if [[ $? -gt 0 ]]; then
-      errorMessage "IPCheck (getRemoteIP 4) request failed $remote_ip"
-      return 0
-    fi
     if [[ $DYNB_UPDATE_METHOD == domrobot ]]; then
       dns_ip=$(getDNSIP A)
     else
-      dig_response=$(dig @${_DNS_checkServer} in a +short "$DYNB_DYN_DOMAIN")
+      dns_ip=$(dig @${_DNS_checkServer} in a +short "$DYNB_DYN_DOMAIN")
-      #TODO: this is duplicated code, refactor this.
-      if [[ $dig_response == ";; connection timed out; no servers could be reached" ]]; then
-        errorMessage "DNS request failed $dig_response"
-        return 0
-      fi
-      dns_ip=$dig_response
     fi
   fi
   if [[ ${1} == 6 ]]; then
     remote_ip=$(getRemoteIP 6 $_ipv6_checker)
-    #TODO: this is duplicated code, refactor this.
-    if [[ $? -gt 0 ]]; then
-      errorMessage "IPCheck (getRemoteIP 6) request failed $remote_ip"
-      return 0
-    fi
     if [[ $DYNB_UPDATE_METHOD == domrobot ]]; then
       dns_ip=$(getDNSIP AAAA)
     else
-      dig_response=$(dig @${_DNS_checkServer} in aaaa +short "$DYNB_DYN_DOMAIN")
+      dns_ip=$(dig @${_DNS_checkServer} in aaaa +short "$DYNB_DYN_DOMAIN")
-      #TODO: this is duplicated code, refactor this.
-      if [[ $dig_response == ";; connection timed out; no servers could be reached" ]]; then
-        errorMessage "DNS request failed $dig_response"
-        return 0
-      fi
-      dns_ip=$dig_response
     fi
   fi
 
@@ -788,15 +757,6 @@ function handleParameters() {
   if [[ $DYNB_DEBUG == true ]]; then
     _debug=1
   fi
-  if [[ -n $DYNB_IPv4_CHECK_SITE ]]; then
-    _ipv4_checker=$DYNB_IPv4_CHECK_SITE
-  fi
-  if [[ -n $DYNB_IPv6_CHECK_SITE ]]; then
-    _ipv6_checker=$DYNB_IPv6_CHECK_SITE
-  fi
-  if [[ -n $DYNB_DNS_CHECK_SERVER ]]; then
-    _DNS_checkServer=$DYNB_DNS_CHECK_SERVER
-  fi
   return 0
 }
 
@@ -805,31 +765,30 @@ function handleParameters() {
 ##################
 
 function checkDependencies() {
-  failCounter=0
+  ## If there will be more general dependencies use a loop
-  for i in curl dig; do
+  # for i in curl and some other stuff; do
-    if ! command -v $i >/dev/null 2>&1; then
+  #   if ! command -v $i >/dev/null 2>&1; then
-      errorMessage "could not find \"$i\", DynB depends on it. "
+  #     echoerr "Error: could not find \"$i\", DynB depends on it. "
-      (( failCounter++ ))
+  #     exit 1
-    fi
+  #   fi
-  done
+  # done
   [[ -x $(command -v jq 2> /dev/null) ]] || {
     if [[ $DYNB_UPDATE_METHOD != dyndns* ]]; then
       echo "This script depends on jq and it is not available." >&2
-      (( failCounter++ ))
-    fi
-  }
-  if [[ failCounter -gt 0 ]]; then
       exit 1
     fi
+  }
 }
 
 function doUnsets() {
   unset _network_interface
   unset _DNS_checkServer
   unset _dns_records
+  unset DYNB_DYN_DOMAIN
   unset _has_getopt
   unset _help_message
   unset _INWX_JSON_API_URL
+  unset DYNB_IP_MODE
   unset _ipv4_checker
   unset _ipv6_checker
   unset _is_IPv4_enabled
@@ -837,21 +796,14 @@ function doUnsets() {
   unset _main_domain
   unset _new_IPv4
   unset _new_IPv6
-  unset _version
-  unset DYNB_DYN_DOMAIN
-  unset DYNB_USERNAME
   unset DYNB_PASSWORD
-  unset DYNB_TOKEN
+  unset DYNB_USERNAME
   unset DYNB_SERVICE_PROVIDER
-  unset DYNB_IP_MODE
+  unset _version
-  unset DYNB_INTERVAL
-  unset DYNB_IPv4_CHECK_SITE
-  unset DYNB_IPv6_CHECK_SITE
-  unset DYNB_DNS_CHECK_SERVER
-  unset DYNB_DEBUG
 }
 
-function doDomrobotUpdates() {
+function doUpdates() {
+  if [[ $DYNB_UPDATE_METHOD == "domrobot" ]]; then
     getMainDomain
     fetchDNSRecords
     if [[ $_is_IPv4_enabled == true ]]; then
@@ -870,9 +822,9 @@ function doDomrobotUpdates() {
         debugMessage "Skip IPv6 record update, it is already up to date"
       fi
     fi
-}
+  fi
 
-function doDynDNS2Updates() {
+  if [[ $DYNB_UPDATE_METHOD == "dyndns" ]]; then
     changed=0
     if [[ $_is_IPv4_enabled == true ]]; then
       ipHasChanged 4
@@ -895,17 +847,8 @@ function doDynDNS2Updates() {
         debugMessage "Skip DynDNS2 update, checkStatus fetched previous error."
       fi
     else
-    debugMessage "Skip DynDNS2 update, IPs are up to date or there is a connection problem"
+      debugMessage "Skip DynDNS2 update, IPs are up to date"
     fi
-}
-
-function doUpdates() {
-  if [[ $DYNB_UPDATE_METHOD == "domrobot" ]]; then
-    doDomrobotUpdates
-  fi
-
-  if [[ $DYNB_UPDATE_METHOD == "dyndns" ]]; then
-    doDynDNS2Updates
   fi
 }
 
@@ -935,8 +878,11 @@ function dynb() {
 
   handleParameters
 
+  ## execute operations
+
+
   if loopMode; then
-    while :
+    while checkStatus
     do
       doUpdates
       sleep $DYNB_INTERVAL