diff --git a/docs/HELPER_SCRIPTS.md b/docs/HELPER_SCRIPTS.md new file mode 100755 index 00000000..035e8c87 --- /dev/null +++ b/docs/HELPER_SCRIPTS.md @@ -0,0 +1,21 @@ +# NetAlertX Community Helper Scripts Overview + +This page provides an overview of community-contributed scripts for NetAlertX. These scripts are not maintained by the NetAlertX team and are provided as-is. + +## Community Scripts + +You can find all scripts in this [scripts GitHub folder](https://github.com/jokob-sk/NetAlertX/tree/main/scripts). + +| Script Name | Description | Author | Version | Release Date | +|------------|-------------|--------|---------|--------------| +| **NetAlertX-New-Devices-Checkmk-Script** | Checks for new devices in NetAlertX and reports status to Checkmk. | N/A | 1.0 | 08-Jan-2025 | +| **DB Cleanup Script** | Queries and removes old device-related entries from the database. | [laxduke](https://github.com/laxduke) | 1.0 | 23-Dec-2024 | +| **NetAlertX OPNsense DHCP Lease Converter** | Retrieves DHCP lease data from OPNsense and converts it to `dnsmasq` format. | [im-redactd](https://github.com/im-redactd) | 1.0 | 24-Feb-2025 | + +## Important Notes + +> [!NOTE] +> These scripts are community-supplied and not actively maintained. Use at your own discretion. + +For detailed usage instructions, refer to each script's documentation. + diff --git a/mkdocs.yml b/mkdocs.yml index 7b134920..4baa145a 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,7 +43,7 @@ nav: - Webhooks (n8n): WEBHOOK_N8N.md - Help: - Common issues: COMMON_ISSUES.md - - Random MAC: RANDOM_MAC.md + - Random MAC: RANDOM_MAC.md - Device guides: - Editing Devices: @@ -71,6 +71,7 @@ nav: - Integrations: - Webhook Secret: WEBHOOK_SECRET.md - API: API.md + - Helper scripts: HELPER_SCRIPTS.md theme: