Files
NetAlertX/front/plugins
2024-05-25 09:54:23 +10:00
..
2024-04-12 19:44:29 +10:00
2024-04-12 19:44:29 +10:00
2024-05-11 12:37:32 +10:00
2024-04-12 19:44:29 +10:00
2024-04-12 19:44:29 +10:00
2024-04-12 19:44:29 +10:00
2024-04-25 14:14:19 +10:00
2024-04-27 10:30:40 +10:00
2024-04-12 19:44:29 +10:00
2024-04-12 19:44:29 +10:00
2024-05-09 07:53:43 +10:00
2024-04-12 19:44:29 +10:00
2024-04-07 12:38:17 +10:00
2024-04-12 19:44:29 +10:00
2024-04-30 23:37:05 +10:00
2024-04-12 19:44:29 +10:00
2024-04-28 10:17:02 +10:00
2024-04-07 12:38:17 +10:00
2024-04-20 10:14:22 +10:00
2024-04-12 19:44:29 +10:00
2024-04-12 19:44:29 +10:00
2024-04-12 19:44:29 +10:00
2024-04-12 19:44:29 +10:00
2024-04-12 19:44:29 +10:00
2024-04-27 10:30:40 +10:00

📚 Docs for individual plugins

Note

Please check this Plugins debugging guide and the corresponding Plugin documentation in the below table if you are facing issues.

🔌 Plugins & 📚 Docs

Required CurrentScan Unique Prefix Data source Type Link + Docs
APPRISE Script 💬 publisher 📚_publisher_apprise
Yes ARPSCAN Script 🔍dev scanner 📚arp_scan
CSVBCKP Script ⚙ system 📚csv_backup
Yes* DBCLNP Script ⚙ system 📚db_cleanup
DDNS Script ⚙ system 📚ddns_update
Yes DHCPLSS Script 🔍dev scanner 📚dhcp_leases
DHCPSRVS Script ♻ other 📚dhcp_servers
Yes INTRNT Script 🔍dev scanner 📚internet_ip
INTRSPD Script ♻ other 📚internet_speedtest
MAINT Script ⚙ system 📚maintenance
MQTT Script 💬 publisher 📚_publisher_mqtt
Yes NEWDEV Template ⚙ system 📚newdev_template
NMAP Script ♻ other 📚nmap_scan
Yes NMAPDEV Script 🔍dev scanner 📚nmap_dev_scan
NSLOOKUP Script ♻ other 📚nslookup_scan
Yes NTFPRCS Template ⚙ system 📚notification_processing
NTFY Script 💬 publisher 📚_publisher_ntfy
PHOLUS Script ♻ other 📚pholus_scan
Yes PIHOLE External SQLite DB 🔍dev scanner 📚pihole_scan
PUSHSAFER Script 💬 publisher 📚_publisher_pushsafer
PUSHOVER Script 💬 publisher 📚_pushover_pushsafer
Yes SETPWD Template ⚙ system 📚set_password
SMTP Script 💬 publisher 📚_publisher_email
Yes SNMPDSC Script 🔍dev scanner 📚snmp_discovery
Yes** UNDIS Script ♻ other 📚undiscoverables
Yes UNFIMP Script 🔍dev scanner 📚unifi_import
VNDRPDT Script ⚙ system 📚vendor_update
WEBHOOK Script 💬 publisher 📚_publisher_webhook
WEBMON Script ♻ other 📚website_monitor
N/A N/A SQL query N/A, but the External SQLite DB plugins work similarly

* 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.

Note

You soft-disable plugins via Settings or completely ignore plugins by placing a ignore_plugin file into the plugin directory. The difference is that ignored plugins don't show up anywhere in the UI (Settings, Device details, Plugins pages). The app skips ignored plugins completely. 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 a least some device-detecting plugins (that insert entries into the CurrentScan table) enabled, such as ARPSCAN or PIHOLE. You can also load/unload Plugins with the LOADED_PLUGINS setting.

It's recommended to use the same schedule interval for all plugins responsible for discovering new devices.

If you want to develop a custom plugin, please read this Plugin development guide.