From a892b8b5fb70c6e896bd639bcb864f179371b2ca Mon Sep 17 00:00:00 2001 From: jokob-sk Date: Thu, 18 Jul 2024 18:10:36 +1000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9ADocs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- front/plugins/README.md | 77 +++++++++++++++++++++++------------------ 1 file changed, 43 insertions(+), 34 deletions(-) diff --git a/front/plugins/README.md b/front/plugins/README.md index 17a0f58b..b58eeb01 100755 --- a/front/plugins/README.md +++ b/front/plugins/README.md @@ -24,40 +24,41 @@ NetAlertX supports additional plugins to extend its functionality, each with its Device-detecting plugins insert values into the `CurrentScan` database table. The plugins that are not required are safe to ignore, however, it makes sense to have at least some device-detecting plugins enabled, such as `ARPSCAN` or `NMAPDEV`. -| ID | Type | Description | Required | Data source | Detailed docs | -|---------------|---------|---------------------------------------------|----------|--------------------|---------------------------------------------------------------| -| `APPRISE` | ▢️ | Apprise notification proxy | | Script | [_publisher_apprise](/front/plugins/_publisher_apprise/) | -| `ARPSCAN` | πŸ” | ARP-scan on current network | | Script | [arp_scan](/front/plugins/arp_scan/) | -| `CSVBCKP` | βš™ | CSV devices backup | | Script | [csv_backup](/front/plugins/csv_backup/) | -| `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/) | -| `DHCPSRVS` | β™» | DHCP servers | | Script | [dhcp_servers](/front/plugins/dhcp_servers/) | -| `INTRNT` | πŸ” | Internet IP scanner | | Script | [internet_ip](/front/plugins/internet_ip/) | -| `INTRSPD` | β™» | Internet speed test | | Script | [internet_speedtest](/front/plugins/internet_speedtest/) | -| `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/) | -| `NEWDEV` | βš™ | New device template | Yes | Template | [newdev_template](/front/plugins/newdev_template/) | -| `NMAP` | β™» | Nmap port scanning & discovery | | Script | [nmap_scan](/front/plugins/nmap_scan/) | -| `NMAPDEV` | πŸ” | Nmap dev scan on current network | | Script | [nmap_dev_scan](/front/plugins/nmap_dev_scan/) | -| `NSLOOKUP` | β™» | NSLookup (DNS-based) name resolution | | Script | [nslookup_scan](/front/plugins/nslookup_scan/) | -| `NTFPRCS` | βš™ | Notification processing | Yes | Template | [notification_processing](/front/plugins/notification_processing/)| -| `NTFY` | ▢️ | NTFY notifications | | Script | [_publisher_ntfy](/front/plugins/_publisher_ntfy/) | -| `PHOLUS` | β™» | Pholus name resolution | | Script | [pholus_scan](/front/plugins/pholus_scan/) | -| `PIHOLE` | πŸ”/πŸ“₯ | Pi-hole device import & sync | | SQLite DB | [pihole_scan](/front/plugins/pihole_scan/) | -| `PUSHSAFER` | ▢️ | Pushsafer notifications | | Script | [_publisher_pushsafer](/front/plugins/_publisher_pushsafer/) | -| `PUSHOVER` | ▢️ | Pushover notifications | | Script | [_publisher_pushover](/front/plugins/_publisher_pushover/) | -| `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 other NetAlertX instances | | Script | [sync](/front/plugins/sync/) | -| `UNDIS` | πŸ”/πŸ“₯ | Create dummy devices | | Script | [undiscoverables](/front/plugins/undiscoverables/) | -| `UNFIMP` | πŸ”/πŸ“₯ | UniFi device import & sync | | Script | [unifi_import](/front/plugins/unifi_import/) | -| `VNDRPDT` | βš™ | Vendor database update | | Script | [vendor_update](/front/plugins/vendor_update/) | -| `WEBHOOK` | ▢️ | Webhook notifications | | Script | [_publisher_webhook](/front/plugins/_publisher_webhook/) | -| `WEBMON` | β™» | Website down monitoring | | Script | [website_monitor](/front/plugins/website_monitor/) | - +| ID | Type | Description | Features | Required | Data source | Detailed docs | +|---------------|---------|--------------------------------------------|----------|----------|--------------------|---------------------------------------------------------------| +| `APPRISE` | ▢️ | Apprise notification proxy | | | Script | [_publisher_apprise](/front/plugins/_publisher_apprise/) | +| `ARPSCAN` | πŸ” | ARP-scan on current network | | | Script | [arp_scan](/front/plugins/arp_scan/) | +| `CSVBCKP` | βš™ | CSV devices backup | | | Script | [csv_backup](/front/plugins/csv_backup/) | +| `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/) | +| `DHCPSRVS` | β™» | DHCP servers | | | Script | [dhcp_servers](/front/plugins/dhcp_servers/) | +| `INTRNT` | πŸ” | Internet IP scanner | | | Script | [internet_ip](/front/plugins/internet_ip/) | +| `INTRSPD` | β™» | Internet speed test | | | Script | [internet_speedtest](/front/plugins/internet_speedtest/) | +| `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/) | +| `NEWDEV` | βš™ | New device template | | Yes | Template | [newdev_template](/front/plugins/newdev_template/) | +| `NMAP` | β™» | Nmap port scanning & discovery | | | Script | [nmap_scan](/front/plugins/nmap_scan/) | +| `NMAPDEV` | πŸ” | Nmap dev scan on current network | | | Script | [nmap_dev_scan](/front/plugins/nmap_dev_scan/) | +| `NSLOOKUP` | β™» | NSLookup (DNS-based) name resolution | | | Script | [nslookup_scan](/front/plugins/nslookup_scan/) | +| `NTFPRCS` | βš™ | Notification processing | | Yes | Template | [notification_processing](/front/plugins/notification_processing/)| +| `NTFY` | ▢️ | NTFY notifications | | | Script | [_publisher_ntfy](/front/plugins/_publisher_ntfy/) | +| `OMDSDN` | πŸ“₯ | OMADA TP-Link import | πŸ“ŠπŸ”„ | | Script | [omada_sdn_imp](/front/plugins/omada_sdn_imp/) | +| `PHOLUS` | β™» | Pholus name resolution | | | Script | [pholus_scan](/front/plugins/pholus_scan/) | +| `PIHOLE` | πŸ”/πŸ“₯ | Pi-hole device import & sync | | | SQLite DB | [pihole_scan](/front/plugins/pihole_scan/) | +| `PUSHSAFER` | ▢️ | Pushsafer notifications | | | Script | [_publisher_pushsafer](/front/plugins/_publisher_pushsafer/) | +| `PUSHOVER` | ▢️ | Pushover notifications | | | Script | [_publisher_pushover](/front/plugins/_publisher_pushover/) | +| `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 | πŸ“ŠπŸ”„ | | Script | [sync](/front/plugins/sync/) | +| `UNDIS` | πŸ”/πŸ“₯ | Create dummy devices | | | Script | [undiscoverables](/front/plugins/undiscoverables/) | +| `UNFIMP` | πŸ”/πŸ“₯ | UniFi device import & sync | | | Script | [unifi_import](/front/plugins/unifi_import/) | +| `VNDRPDT` | βš™ | Vendor database update | | | Script | [vendor_update](/front/plugins/vendor_update/) | +| `WEBHOOK` | ▢️ | Webhook notifications | | | Script | [_publisher_webhook](/front/plugins/_publisher_webhook/) | +| `WEBMON` | β™» | Website down monitoring | | | Script | [website_monitor](/front/plugins/website_monitor/) | + > \* The database cleanup plugin (`DBCLNP`) is not _required_ but the app will become unusable after a while if not executed. > @@ -76,6 +77,14 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T | system | βš™ | Providing core system functionality. | `schedule` / always on | βœ–/βœ” | Script / Template | | other | β™» | Other scanners, e.g. for name resolution | misc | βœ– | Script / Template | +## Features + +| Icon | Description | +|------|---------------------------------------------------------------| +| πŸ“Š | Auto-imports the network topology diagram | +| πŸ”„ | Has the option to sync some data back into the plugin source | + + ## βœ…Enabling plugins Plugins can be enabled via Settings, and can be disabled as needed.