Skip to content

Commit 5562ae7

Browse files
author
jokob-sk
committed
docs + wf
1 parent 4363e08 commit 5562ae7

File tree

13 files changed

+48
-26
lines changed

13 files changed

+48
-26
lines changed

‎.github/workflows/social_post_on_release.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ jobs:
1212

1313
# Post to Twitter
1414
- name: Post to Twitter
15-
uses: gr2m/twitter-together@v2
15+
uses: twitter-together/action@v3
1616
env:
1717
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
18-
TWITTER_API_KEY: ${{ secrets.TWITTER_API_KEY }}
19-
TWITTER_API_SECRET: ${{ secrets.TWITTER_API_SECRET }}
2018
TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }}
2119
TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
20+
TWITTER_API_KEY: ${{ secrets.TWITTER_API_KEY }}
21+
TWITTER_API_SECRET_KEY: ${{ secrets.TWITTER_API_SECRET_KEY }}
2222
with:
2323
tweet: |
2424
🎉 New release: **${{ github.event.release.name }}** is live! 🚀

‎front/plugins/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T
2828
| `APPRISE` | ▶️ | Apprise notification proxy | | | Script | [_publisher_apprise](/front/plugins/_publisher_apprise/) |
2929
| `ARPSCAN` | 🔍 | ARP-scan on current network | | | Script | [arp_scan](/front/plugins/arp_scan/) |
3030
| `AVAHISCAN` | 🆎 | Avahi (mDNS-based) name resolution | | | Script | [avahi_scan](/front/plugins/avahi_scan/) |
31+
| `ASUSWRT` | 🔍 | Import connected devices from AsusWRT | | | Script | [asuswrt_import](/front/plugins/asuswrt_import/) |
3132
| `CSVBCKP` | ⚙ | CSV devices backup | | | Script | [csv_backup](/front/plugins/csv_backup/) |
32-
| `CUSTPROP` | ⚙ | Managing custom device properties values | | Yes | Template | [custom_props](/front/plugins/custom_props/) |
33+
| `CUSTPROP` | ⚙ | Managing custom device properties values | | Yes | Template | [custom_props](/front/plugins/custom_props/) |
3334
| `DBCLNP` | ⚙ | Database cleanup | | Yes* | Script | [db_cleanup](/front/plugins/db_cleanup/) |
3435
| `DDNS` | ⚙ | DDNS update | | | Script | [ddns_update](/front/plugins/ddns_update/) |
3536
| `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
3940
| `INTRNT` | 🔍 | Internet IP scanner | | | Script | [internet_ip](/front/plugins/internet_ip/) |
4041
| `INTRSPD` | ♻ | Internet speed test | | | Script | [internet_speedtest](/front/plugins/internet_speedtest/) |
4142
| `IPNEIGH` | 🔍 | Scan ARP (IPv4) and NDP (IPv6) tables | | | Script | [ipneigh](/front/plugins/ipneigh/) |
42-
| `LUCIRPC` | 🔍 | Import connected devices from OpenWRT | | | Script | [luci_import](/front/plugins/luci_import/) |
43-
| `ASUSWRT` | 🔍 | Import connected devices from AsusWRT | | | Script | [asuswrt_import](/front/plugins/asuswrt_import/) |
43+
| `LUCIRPC` | 🔍 | Import connected devices from OpenWRT | | | Script | [luci_import](/front/plugins/luci_import/) |
4444
| `MAINT` | ⚙ | Maintenance of logs, etc. | | | Script | [maintenance](/front/plugins/maintenance/) |
4545
| `MQTT` | ▶️ | MQTT for synching to Home Assistant | | | Script | [_publisher_mqtt](/front/plugins/_publisher_mqtt/) |
4646
| `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
5757
| `SETPWD` | ⚙ | Set password | | Yes | Template | [set_password](/front/plugins/set_password/) |
5858
| `SMTP` | ▶️ | Email notifications | | | Script | [_publisher_email](/front/plugins/_publisher_email/) |
5959
| `SNMPDSC` | 🔍/📥 | SNMP device import & sync | | | Script | [snmp_discovery](/front/plugins/snmp_discovery/) |
60-
| `SYNC` | 🔍/⚙/📥| Sync & import from NetAlertX instances | 🖧 🔄 | Yes | Script | [sync](/front/plugins/sync/) |
60+
| `SYNC` | 🔍/⚙/📥| Sync & import from NetAlertX instances | 🖧 🔄 | Yes | Script | [sync](/front/plugins/sync/) |
6161
| `TELEGRAM` | ▶️ | Telegram notifications | | | Script | [_publisher_telegram](/front/plugins/_publisher_telegram/) |
6262
| `UI` | ♻ | UI specific settings | | Yes | Template | [ui_settings](/front/plugins/ui_settings/) |
6363
| `UNDIS` | 🔍/📥 | Create dummy devices ❌ | | | Script | [undiscoverables](/front/plugins/undiscoverables/) |
@@ -69,7 +69,7 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T
6969

7070

7171
> \* The database cleanup plugin (`DBCLNP`) is not _required_ but the app will become unusable after a while if not executed.
72-
> \** The Undiscoverables plugin (`UNDIS`) inserts only user-specified dummy devices.
72+
> \*\* The Undiscoverables plugin (`UNDIS`) inserts only user-specified dummy devices.
7373
> ❌ marked for removal
7474
> ⌚It's recommended to use the same schedule interval for all plugins responsible for discovering new devices.
7575

‎front/plugins/__template/README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,8 @@ To set up the plugin correctly, make sure...
2020

2121
### Notes
2222

23-
- Additional notes, limitations, Author info.
23+
- Additional notes, limitations, Author info.
24+
25+
- Version: 1.0.0
26+
- Author: `<your github handle>`
27+
- Release Date: `<release date>`

‎front/plugins/asuswrt_import/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This Plugin is using awesome [asusrouter](https://github.com/Vaskivskyi/asusrout
1515

1616
## Other info
1717

18-
Version: 1.0.0
19-
Date: 16.1.2025
20-
Author: @labmonkey
18+
- Version: 1.0.0
19+
- Author: [labmonkey](https://github.com/labmonkey)
20+
- Release Date: 16.1.2025
21+

‎front/plugins/freebox/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ If the Freebox is your gateway you need to find its HTTPS (or HTTP if you prefer
5050
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`.
5151

5252

53-
### Other info
53+
## Other info
5454

55-
- Author : [KayJay7](https://github.com/KayJay7) & [Lucide](https://github.com/Lucide)
56-
- Date : 2-Dec-2024 - version 1.0
55+
- Version: 1.0
56+
- Author: [KayJay7](https://github.com/KayJay7) & [Lucide](https://github.com/Lucide)
57+
- Release Date: 2-Dec-2024

‎front/plugins/icmp_scan/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,9 @@ Plugin for pinging existing devices via the [ping](https://linux.die.net/man/8/p
55
### Usage
66

77
- Check the Settings page for details.
8+
9+
## Other info
10+
11+
- Version: 1.0.0
12+
- Author: [jokob-sk](https://github.com/jokob-sk)
13+
- Release Date: 19.1.2025

‎front/plugins/internet_ip/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,10 @@ Plugin to run regular Internet connectivity and IP checks. Change the [dig utili
88
### Usage
99

1010
- Check the Settings page for details.
11+
12+
13+
## Other info
14+
15+
- Version: 1.0.0
16+
- Author: [jokob-sk](https://github.com/jokob-sk)
17+
- Release Date: 1.1.2023

‎front/plugins/internet_ip/script.py

-2
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ def main():
6868

6969
new_internet_IP, cmd_output = check_internet_IP( PREV_IP, DIG_GET_IP_ARG)
7070

71-
#todo: use `curl ifconfig.me/ip` if above fails
72-
7371
if new_internet_IP == no_internet_ip:
7472
time.sleep(1*i) # Exponential backoff strategy
7573
else:

‎front/plugins/ipneigh/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ To set up the plugin correctly, make sure to add in the plugin settings the name
2121
- `ARPSCAN` does a better job at discovering IPv4 devices because it explicitly sends arp requests
2222
- 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
2323

24-
### Other info
24+
## Other info
2525

26-
- Author : [KayJay7](https://github.com/KayJay7)
27-
- Date : 31-Nov-2024 - version 1.0
26+
- Version: 1.0
27+
- Author: [KayJay7](https://github.com/KayJay7)
28+
- Release Date: 31-Nov-2024

‎front/plugins/luci_import/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ The plugin is used to import connected devices from OpenWRT
44

55
### Other info
66

7-
- Author : [vaga9938](https://github.com/vaga9938)
8-
- Date : 28-Dec-2024 - version 1.0
7+
- Version: 1.0
8+
- Author: [vaga9938](https://github.com/vaga9938)
9+
- Release Date: 28-Dec-2024
910

‎front/plugins/omada_sdn_imp/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ can not fix some of tplinks OMADA SDN own limitations/bugs:
6565

6666

6767

68-
### Other info
68+
## Other info
6969

70+
- Version: 1.0
7071
- Author : [Flying Toto](https://github.com/FlyingToto)
71-
- Date : 04-Jul-2024 - version 1.0
72+
- Release Date: 04-Jul-2024

‎scripts/checkmk/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ For more details, see the [Checkmk Local Checks Documentation](https://docs.chec
1717

1818
### Other info
1919

20-
- Date : 08-Jan-2025 - version 1.0
20+
- Version: 1.0
2121
- Author: N/A
22+
- Release Date: 08-Jan-2025
2223

2324
> [!NOTE]
2425
> This is a community supplied script and not maintained.

‎scripts/db_cleanup/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ For each MAC or IP address provided, the script:
3434

3535
### Other info
3636

37-
- Date : 23-Dec-2024 - version 1.0
37+
- Version: 1.0
38+
- Release Date: 23-Dec-2024
3839
- Author: [laxduke](https://github.com/laxduke)
3940

4041

0 commit comments

Comments
 (0)