From 5562ae7addfd74d8cbbf7cc663af02981d2d6c5e Mon Sep 17 00:00:00 2001 From: jokob-sk Date: Sun, 19 Jan 2025 23:19:26 +1100 Subject: [PATCH] docs + wf --- .github/workflows/social_post_on_release.yml | 6 +++--- front/plugins/README.md | 10 +++++----- front/plugins/__template/README.md | 6 +++++- front/plugins/asuswrt_import/README.md | 7 ++++--- front/plugins/freebox/README.md | 7 ++++--- front/plugins/icmp_scan/README.md | 6 ++++++ front/plugins/internet_ip/README.md | 7 +++++++ front/plugins/internet_ip/script.py | 2 -- front/plugins/ipneigh/README.md | 7 ++++--- front/plugins/luci_import/README.md | 5 +++-- front/plugins/omada_sdn_imp/README.md | 5 +++-- scripts/checkmk/README.md | 3 ++- scripts/db_cleanup/README.md | 3 ++- 13 files changed, 48 insertions(+), 26 deletions(-) diff --git a/.github/workflows/social_post_on_release.yml b/.github/workflows/social_post_on_release.yml index e42490e2..5ea96b7f 100755 --- a/.github/workflows/social_post_on_release.yml +++ b/.github/workflows/social_post_on_release.yml @@ -12,13 +12,13 @@ jobs: # Post to Twitter - name: Post to Twitter - uses: gr2m/twitter-together@v2 + uses: twitter-together/action@v3 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - TWITTER_API_KEY: ${{ secrets.TWITTER_API_KEY }} - TWITTER_API_SECRET: ${{ secrets.TWITTER_API_SECRET }} TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }} TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }} + TWITTER_API_KEY: ${{ secrets.TWITTER_API_KEY }} + TWITTER_API_SECRET_KEY: ${{ secrets.TWITTER_API_SECRET_KEY }} with: tweet: | πŸŽ‰ New release: **${{ github.event.release.name }}** is live! πŸš€ diff --git a/front/plugins/README.md b/front/plugins/README.md index f917d905..79d70953 100755 --- a/front/plugins/README.md +++ b/front/plugins/README.md @@ -28,8 +28,9 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T | `APPRISE` | ▢️ | Apprise notification proxy | | | Script | [_publisher_apprise](/front/plugins/_publisher_apprise/) | | `ARPSCAN` | πŸ” | ARP-scan on current network | | | Script | [arp_scan](/front/plugins/arp_scan/) | | `AVAHISCAN` | πŸ†Ž | Avahi (mDNS-based) name resolution | | | Script | [avahi_scan](/front/plugins/avahi_scan/) | +| `ASUSWRT` | πŸ” | Import connected devices from AsusWRT | | | Script | [asuswrt_import](/front/plugins/asuswrt_import/) | | `CSVBCKP` | βš™ | CSV devices backup | | | Script | [csv_backup](/front/plugins/csv_backup/) | -| `CUSTPROP` | βš™ | Managing custom device properties values | | Yes | Template | [custom_props](/front/plugins/custom_props/) | +| `CUSTPROP` | βš™ | Managing custom device properties values | | Yes | Template | [custom_props](/front/plugins/custom_props/) | | `DBCLNP` | βš™ | Database cleanup | | Yes* | Script | [db_cleanup](/front/plugins/db_cleanup/) | | `DDNS` | βš™ | DDNS update | | | Script | [ddns_update](/front/plugins/ddns_update/) | | `DHCPLSS` | πŸ”/πŸ“₯/πŸ†Ž| Import devices from DHCP leases | | | Script | [dhcp_leases](/front/plugins/dhcp_leases/) | @@ -39,8 +40,7 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T | `INTRNT` | πŸ” | Internet IP scanner | | | Script | [internet_ip](/front/plugins/internet_ip/) | | `INTRSPD` | β™» | Internet speed test | | | Script | [internet_speedtest](/front/plugins/internet_speedtest/) | | `IPNEIGH` | πŸ” | Scan ARP (IPv4) and NDP (IPv6) tables | | | Script | [ipneigh](/front/plugins/ipneigh/) | -| `LUCIRPC` | πŸ” | Import connected devices from OpenWRT | | | Script | [luci_import](/front/plugins/luci_import/) | -| `ASUSWRT` | πŸ” | Import connected devices from AsusWRT | | | Script | [asuswrt_import](/front/plugins/asuswrt_import/) | +| `LUCIRPC` | πŸ” | Import connected devices from OpenWRT | | | Script | [luci_import](/front/plugins/luci_import/) | | `MAINT` | βš™ | Maintenance of logs, etc. | | | Script | [maintenance](/front/plugins/maintenance/) | | `MQTT` | ▢️ | MQTT for synching to Home Assistant | | | Script | [_publisher_mqtt](/front/plugins/_publisher_mqtt/) | | `NBTSCAN` | πŸ†Ž | Nbtscan (NetBIOS-based) name resolution | | | Script | [nbtscan_scan](/front/plugins/nbtscan_scan/) | @@ -57,7 +57,7 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T | `SETPWD` | βš™ | Set password | | Yes | Template | [set_password](/front/plugins/set_password/) | | `SMTP` | ▢️ | Email notifications | | | Script | [_publisher_email](/front/plugins/_publisher_email/) | | `SNMPDSC` | πŸ”/πŸ“₯ | SNMP device import & sync | | | Script | [snmp_discovery](/front/plugins/snmp_discovery/) | -| `SYNC` | πŸ”/βš™/πŸ“₯| Sync & import from NetAlertX instances | πŸ–§ πŸ”„ | Yes | Script | [sync](/front/plugins/sync/) | +| `SYNC` | πŸ”/βš™/πŸ“₯| Sync & import from NetAlertX instances | πŸ–§ πŸ”„ | Yes | Script | [sync](/front/plugins/sync/) | | `TELEGRAM` | ▢️ | Telegram notifications | | | Script | [_publisher_telegram](/front/plugins/_publisher_telegram/) | | `UI` | β™» | UI specific settings | | Yes | Template | [ui_settings](/front/plugins/ui_settings/) | | `UNDIS` | πŸ”/πŸ“₯ | Create dummy devices ❌ | | | Script | [undiscoverables](/front/plugins/undiscoverables/) | @@ -69,7 +69,7 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T > \* The database cleanup plugin (`DBCLNP`) is not _required_ but the app will become unusable after a while if not executed. -> \** The Undiscoverables plugin (`UNDIS`) inserts only user-specified dummy devices. +> \*\* The Undiscoverables plugin (`UNDIS`) inserts only user-specified dummy devices. > ❌ marked for removal > ⌚It's recommended to use the same schedule interval for all plugins responsible for discovering new devices. diff --git a/front/plugins/__template/README.md b/front/plugins/__template/README.md index 4c0aa412..f99a3b36 100755 --- a/front/plugins/__template/README.md +++ b/front/plugins/__template/README.md @@ -20,4 +20,8 @@ To set up the plugin correctly, make sure... ### Notes -- Additional notes, limitations, Author info. \ No newline at end of file +- Additional notes, limitations, Author info. + +- Version: 1.0.0 +- Author: `` +- Release Date: `` \ No newline at end of file diff --git a/front/plugins/asuswrt_import/README.md b/front/plugins/asuswrt_import/README.md index eb973330..98e60c7e 100755 --- a/front/plugins/asuswrt_import/README.md +++ b/front/plugins/asuswrt_import/README.md @@ -15,6 +15,7 @@ This Plugin is using awesome [asusrouter](https://github.com/Vaskivskyi/asusrout ## Other info -Version: 1.0.0 -Date: 16.1.2025 -Author: @labmonkey +- Version: 1.0.0 +- Author: [labmonkey](https://github.com/labmonkey) +- Release Date: 16.1.2025 + diff --git a/front/plugins/freebox/README.md b/front/plugins/freebox/README.md index ad71cb7f..2ecc8d60 100755 --- a/front/plugins/freebox/README.md +++ b/front/plugins/freebox/README.md @@ -50,7 +50,8 @@ If the Freebox is your gateway you need to find its HTTPS (or HTTP if you prefer As address, you can either use the public IP of the Freebox, or the unique domain name you found on http://mafreebox.freebox.fr:80/api_version listed as `api_domain`. -### Other info +## Other info -- Author : [KayJay7](https://github.com/KayJay7) & [Lucide](https://github.com/Lucide) -- Date : 2-Dec-2024 - version 1.0 \ No newline at end of file +- Version: 1.0 +- Author: [KayJay7](https://github.com/KayJay7) & [Lucide](https://github.com/Lucide) +- Release Date: 2-Dec-2024 \ No newline at end of file diff --git a/front/plugins/icmp_scan/README.md b/front/plugins/icmp_scan/README.md index 65c21c6a..57f9c6bf 100755 --- a/front/plugins/icmp_scan/README.md +++ b/front/plugins/icmp_scan/README.md @@ -5,3 +5,9 @@ Plugin for pinging existing devices via the [ping](https://linux.die.net/man/8/p ### Usage - Check the Settings page for details. + +## Other info + +- Version: 1.0.0 +- Author: [jokob-sk](https://github.com/jokob-sk) +- Release Date: 19.1.2025 diff --git a/front/plugins/internet_ip/README.md b/front/plugins/internet_ip/README.md index 79fb8cc6..4301e253 100755 --- a/front/plugins/internet_ip/README.md +++ b/front/plugins/internet_ip/README.md @@ -8,3 +8,10 @@ Plugin to run regular Internet connectivity and IP checks. Change the [dig utili ### Usage - Check the Settings page for details. + + +## Other info + +- Version: 1.0.0 +- Author: [jokob-sk](https://github.com/jokob-sk) +- Release Date: 1.1.2023 \ No newline at end of file diff --git a/front/plugins/internet_ip/script.py b/front/plugins/internet_ip/script.py index 73579058..574052c7 100755 --- a/front/plugins/internet_ip/script.py +++ b/front/plugins/internet_ip/script.py @@ -68,8 +68,6 @@ def main(): new_internet_IP, cmd_output = check_internet_IP( PREV_IP, DIG_GET_IP_ARG) - #todo: use `curl ifconfig.me/ip` if above fails - if new_internet_IP == no_internet_ip: time.sleep(1*i) # Exponential backoff strategy else: diff --git a/front/plugins/ipneigh/README.md b/front/plugins/ipneigh/README.md index 528c5246..dcd72ed0 100755 --- a/front/plugins/ipneigh/README.md +++ b/front/plugins/ipneigh/README.md @@ -21,7 +21,8 @@ To set up the plugin correctly, make sure to add in the plugin settings the name - `ARPSCAN` does a better job at discovering IPv4 devices because it explicitly sends arp requests - IPv6 devices will often have multiple addresses, but the ping answer will contain only one. This means that in general this plugin will not discover every address but only those who answer -### Other info +## Other info -- Author : [KayJay7](https://github.com/KayJay7) -- Date : 31-Nov-2024 - version 1.0 +- Version: 1.0 +- Author: [KayJay7](https://github.com/KayJay7) +- Release Date: 31-Nov-2024 diff --git a/front/plugins/luci_import/README.md b/front/plugins/luci_import/README.md index e8e3decf..b4009197 100755 --- a/front/plugins/luci_import/README.md +++ b/front/plugins/luci_import/README.md @@ -4,6 +4,7 @@ The plugin is used to import connected devices from OpenWRT ### Other info -- Author : [vaga9938](https://github.com/vaga9938) -- Date : 28-Dec-2024 - version 1.0 +- Version: 1.0 +- Author: [vaga9938](https://github.com/vaga9938) +- Release Date: 28-Dec-2024 diff --git a/front/plugins/omada_sdn_imp/README.md b/front/plugins/omada_sdn_imp/README.md index 28074662..32457d37 100755 --- a/front/plugins/omada_sdn_imp/README.md +++ b/front/plugins/omada_sdn_imp/README.md @@ -65,7 +65,8 @@ can not fix some of tplinks OMADA SDN own limitations/bugs: -### Other info +## Other info +- Version: 1.0 - Author : [Flying Toto](https://github.com/FlyingToto) -- Date : 04-Jul-2024 - version 1.0 +- Release Date: 04-Jul-2024 diff --git a/scripts/checkmk/README.md b/scripts/checkmk/README.md index 78f6a51c..69e4b4e8 100755 --- a/scripts/checkmk/README.md +++ b/scripts/checkmk/README.md @@ -17,8 +17,9 @@ For more details, see the [Checkmk Local Checks Documentation](https://docs.chec ### Other info -- Date : 08-Jan-2025 - version 1.0 +- Version: 1.0 - Author: N/A +- Release Date: 08-Jan-2025 > [!NOTE] > This is a community supplied script and not maintained. \ No newline at end of file diff --git a/scripts/db_cleanup/README.md b/scripts/db_cleanup/README.md index 8dd165b8..af2ad292 100755 --- a/scripts/db_cleanup/README.md +++ b/scripts/db_cleanup/README.md @@ -34,7 +34,8 @@ For each MAC or IP address provided, the script: ### Other info -- Date : 23-Dec-2024 - version 1.0 +- Version: 1.0 +- Release Date: 23-Dec-2024 - Author: [laxduke](https://github.com/laxduke)