[dynamicdns] Updated docs

vroncevic · Dec 17, 2023 · 8a00ad5 · 8a00ad5
1 parent 3867a23
commit 8a00ad5
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 77 deletions.
diff --git a/.github/workflows/dynamicdns_docker_checker.yml b/.github/workflows/dynamicdns_docker_checker.yml
diff --git a/.github/workflows/dynamicdns_shell_checker.yml b/.github/workflows/dynamicdns_shell_checker.yml
@@ -1,23 +1,22 @@
-name: dynamicdns shell checker
+name: dynamicdns_shell_checker
 on:
   push:
     branches: [ master ]
+    paths:
+      - 'sh_tool/**'
   pull_request:
     branches: [ master ]
+    paths:
+      - 'sh_tool/**'
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Check syntax script
-        id: syntax_checker
-        run: bash -n sh_tool/bin/dynamicdns.sh && echo ::set-output name=status::success || echo ::set-output name=status::failure
+      - uses: actions/checkout@v4
       - name: Check size script
         id: size_checker
         run: |
-          echo Checking size
-          code_line_number=$(wc -l < sh_tool/bin/dynamicdns.sh)
-          [[ $code_line_number -gt 300 ]] && echo ::set-output name=status::failure || echo ::set-output name=status::success
-      - name: Check on failures
-        if: steps.syntax_checker.outputs.status == 'failure' || steps.size_checker.outputs.status == 'failure'
-        run: exit 1
+          modules_ok=0
+          modules=($(find sh_tool/ -type f -name '*.sh' -exec echo '{}' \;))
+          for mod in "${modules[@]}"; do line_numbers=$(wc -l < "${mod}"); [[ $line_numbers -gt 300 ]]  && modules_ok=1; done
+          [[ $modules_ok -eq 0 ]] && echo ok || exit 1
diff --git a/.github/workflows/dynamicdns_toc.yml b/.github/workflows/dynamicdns_toc.yml
@@ -1,8 +1,8 @@
-name: dynamicdns toc
+name: dynamicdns_toc
 on: push
 jobs:
   generateTOC:
     name: TOC Generator
     runs-on: ubuntu-latest
     steps:
-      - uses: technote-space/toc-generator@v2
+      - uses: technote-space/toc-generator@v4
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-# Copyright 2015 Vladimir Roncevic <elektron.ronca@gmail.com>
+# Copyright 2016 - 2024 Vladimir Roncevic <elektron.ronca@gmail.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,7 +13,7 @@
 # limitations under the License.
 #
 
-FROM debian:10
+FROM debian:12
 RUN apt-get update
 RUN DEBIAN_FRONTEND=noninteractive \
     apt-get install -yq --no-install-recommends \
@@ -25,8 +25,8 @@ RUN DEBIAN_FRONTEND=noninteractive \
     openssl \
     ddclient
 
-RUN wget https://github.com/vroncevic/sh_util/archive/v1.0.zip
-RUN unzip v1.0.zip
+RUN wget https://github.com/vroncevic/sh_util/archive/1.0.zip
+RUN unzip 1.0.zip
 RUN find /sh_util-1.0/ -name "*.editorconfig" -type f -exec rm -Rf {} \;
 RUN mkdir -p /root/scripts/sh_util/ver.1.0/
 RUN cp -R /sh_util-1.0/sh_tool/bin/   /root/scripts/sh_util/ver.1.0/

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 Developed in **[bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))** code: **100%**.
 
-[![dynamicdns shell checker](https://github.com/vroncevic/dynamicdns/workflows/dynamicdns%20shell%20checker/badge.svg)](https://github.com/vroncevic/dynamicdns/actions?query=workflow%3A%22dynamicdns+shell+checker%22)
+[![dynamicdns_shell_checker](https://github.com/vroncevic/dynamicdns/actions/workflows/dynamicdns_shell_checker.yml/badge.svg)](https://github.com/vroncevic/dynamicdns/actions/workflows/dynamicdns_shell_checker.yml)
 
 The README is used to introduce the tool and provide instructions on
 how to install the tool, any machine dependencies it may have and any
@@ -45,7 +45,7 @@ cp -R ~/sh_tool/log/   /root/scripts/dynamicdns/ver.x.y/
 
 Self generated setup script and execution
 ```
-./dynamicdns_setup.sh
+./dynamicdns_setup.sh 
 
 [setup] installing App/Tool/Script dynamicdns
 	Mon 22 Nov 2021 12:41:00 AM CET
@@ -74,8 +74,6 @@ lrwxrwxrwx 1 root root 50 Nov 22 00:41 /root/bin/dynamicdns -> /root/scripts/dyn
 
 Or You can use docker to create image/container.
 
-[![dynamicdns docker checker](https://github.com/vroncevic/dynamicdns/workflows/dynamicdns%20docker%20checker/badge.svg)](https://github.com/vroncevic/dynamicdns/actions?query=workflow%3A%22dynamicdns+docker+checker%22)
-
 ### Usage
 
 ```
@@ -86,31 +84,7 @@ ln -s /root/scripts/dynamicdns/ver.x.y/bin/dynamicdns.sh /root/bin/dynamicdns
 export PATH=${PATH}:/root/bin/
 
 # Start dynamic dns client
-dynamicdns help
-
-dynamicdns ver.2.0
-Sun 05 Dec 2021 01:02:59 PM CET
-
-[check_root] Check permission for current session? [ok]
-[check_root] Done
-
-	                                                         
-	     _                             _         _           
-	  __| |_   _ _ __   __ _ _ __ ___ (_) ___ __| |_ __  ___ 
-	 / _` | | | | '_ \ / _` | '_ ` _ \| |/ __/ _` | '_ \/ __|
-	| (_| | |_| | | | | (_| | | | | | | | (_| (_| | | | \__ \
-	 \__,_|\__, |_| |_|\__,_|_| |_| |_|_|\___\__,_|_| |_|___/
-	       |___/                                             
-	                                                         
-		Info   github.io/dynamicdns ver.2.0
-		Issue  github.io/issue
-		Author vroncevic.github.io
-
-  [USAGE] dynamicdns [OPTIONS]
-  [OPTIONS]
-  # Start dynamic dns client
-  dynamicdns
-  [help | h] print this option
+dynamicdns
 ```
 
 ### Dependencies
@@ -150,7 +124,7 @@ More documentation and info at
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-Copyright (C) 2016 by [vroncevic.github.io/dynamicdns](https://vroncevic.github.io/dynamicdns)
+Copyright (C) 2016 - 2024 by [vroncevic.github.io/dynamicdns](https://vroncevic.github.io/dynamicdns)
 
 **dynamicdns** is free software; you can redistribute it and/or modify
 it under the same terms as Bash itself, either Bash version 4.2.47 or,

diff --git a/sh_tool/bin/dynamicdns.sh b/sh_tool/bin/dynamicdns.sh
@@ -74,11 +74,11 @@ TOOL_NOTIFY="false"
 #
 function __dyndns {
     local HELP=$1
-    display_logo
     if [ "${HELP}" == "help" ]; then
         usage DYNAMICDNS_USAGE
         exit 0
     fi
+    display_logo
     local FUNC=${FUNCNAME[0]} MSG="None" STATUS_CONF STATUS_CONF_UTIL STATUS
     MSG="Loading basic and util configuration!"
     info_debug_message "$MSG" "$FUNC" "$DYNAMICDNS_TOOL"
@@ -145,4 +145,4 @@ if [ $STATUS -eq $SUCCESS ]; then
     __dyndns $1
 fi
 
-exit 127
+exit 127
diff --git a/sh_tool/conf/dynamicdns.logo b/sh_tool/conf/dynamicdns.logo
@@ -1,8 +1,10 @@
-
-     _                             _         _           
-  __| |_   _ _ __   __ _ _ __ ___ (_) ___ __| |_ __  ___ 
- / _` | | | | '_ \ / _` | '_ ` _ \| |/ __/ _` | '_ \/ __|
-| (_| | |_| | | | | (_| | | | | | | | (_| (_| | | | \__ \
- \__,_|\__, |_| |_|\__,_|_| |_| |_|_|\___\__,_|_| |_|___/
-       |___/                                             
-
+
+        ██                                         ██              ██                   
+       ░██                                        ░░              ░██                   
+       ░██  ██   ██ ███████   ██████   ██████████  ██  █████      ░██ ███████   ██████  
+    ██████ ░░██ ██ ░░██░░░██ ░░░░░░██ ░░██░░██░░██░██ ██░░░██  ██████░░██░░░██ ██░░░░   
+   ██░░░██  ░░███   ░██  ░██  ███████  ░██ ░██ ░██░██░██  ░░  ██░░░██ ░██  ░██░░█████   
+  ░██  ░██   ░██    ░██  ░██ ██░░░░██  ░██ ░██ ░██░██░██   ██░██  ░██ ░██  ░██ ░░░░░██  
+  ░░██████   ██     ███  ░██░░████████ ███ ░██ ░██░██░░█████ ░░██████ ███  ░██ ██████   
+   ░░░░░░   ██     ░░░   ░░  ░░░░░░░░ ░░░  ░░  ░░ ░░  ░░░░░   ░░░░░░ ░░░   ░░ ░░░░░░    
+           ░░