Skip to content

Commit f562df9

Browse files
committed
Merge branch 'next_release' of https://github.com/netalertx/NetAlertX into next_release
2 parents 8cb466e + e7f0be3 commit f562df9

6 files changed

Lines changed: 32 additions & 315 deletions

File tree

docs/API_DEVICE_FIELD_LOCK.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,6 @@ The authoritative field update logic prevents plugin overwrites:
151151
## See Also
152152

153153
- [Device locking](./DEVICE_FIELD_LOCK.md)
154-
- [Device source fields](./DEVICE_SOURCE_FIELDS.md)
154+
- [Device source fields - Authoritative updates](./DEVICE_SOURCE_FIELDS.md)
155155
- [API Device Endpoints Documentation](./API_DEVICE.md)
156-
- [Authoritative Field Updates System](./PLUGINS_DEV.md#authoritative-fields)
157156
- [Plugin Configuration Reference](./PLUGINS_DEV_CONFIG.md)

docs/DEVICE_FIELD_LOCK.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,8 @@ Overwrite rules are
157157
## See also
158158

159159
- [Device locking](./DEVICE_FIELD_LOCK.md)
160-
- [Device source fields](./DEVICE_SOURCE_FIELDS.md)
160+
- [Device source fields - Authoritative updates](./DEVICE_SOURCE_FIELDS.md)
161161
- [API Device Endpoints Documentation](./API_DEVICE.md)
162-
- [Authoritative Field Updates System](./PLUGINS_DEV.md#authoritative-fields)
163162
- [Plugin Configuration Reference](./PLUGINS_DEV_CONFIG.md)
164163
- [Device locking APIs](API_DEVICE_FIELD_LOCK.md)
165164
- [Device management](DEVICE_MANAGEMENT.md)

docs/DEVICE_SOURCE_FIELDS.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,8 @@ Some fields, like **IP Addresses** (`devLastIP`) and **Full Domain Names** (`dev
6565
## See also:
6666

6767
- [Device locking](./DEVICE_FIELD_LOCK.md)
68-
- [Device source fields](./DEVICE_SOURCE_FIELDS.md)
68+
- [Device source fields - Authoritative updates](./DEVICE_SOURCE_FIELDS.md)
6969
- [API Device Endpoints Documentation](./API_DEVICE.md)
70-
- [Authoritative Field Updates System](./PLUGINS_DEV.md#authoritative-fields)
7170
- [Plugin Configuration Reference](./PLUGINS_DEV_CONFIG.md)
7271
- [Device locking APIs](API_DEVICE_FIELD_LOCK.md)
7372
- [Device management](DEVICE_MANAGEMENT.md)

docs/PLUGINS.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,20 @@ NetAlertX supports additional plugins to extend its functionality, each with its
2222

2323
## Plugin types
2424

25-
| Plugin type | Icon | Description | When to run | Required | Data source [?](./PLUGINS_DEV.md) |
26-
| -------------- | ---- | ---------------------------------------------------------------- | ----------------------------------- | -------- | ------------------------------------- |
27-
| publisher | ▶️ | Sending notifications to services. | `on_notification` || Script |
28-
| dev scanner | 🔍 | Create devices in the app, manages online/offline device status. | `schedule` || Script / SQLite DB |
29-
| name discovery | 🆎 | Discovers names of devices via various protocols. | `before_name_updates`, `schedule` || Script |
30-
| importer | 📥 | Importing devices from another service. | `schedule` || Script / SQLite DB |
31-
| system || Providing core system functionality. | `schedule` / always on | ✖/✔ | Script / Template |
32-
| other || Other plugins | misc || Script / Template |
25+
| Plugin type | Icon | Description | When to run | Required | Data source [?](./PLUGINS_DEV.md) |
26+
| -------------- | ---- | ------------------------------------------------------------------------- | ----------------------------------- | -------- | ------------------------------------- |
27+
| publisher | ▶️ | Sending notifications to services. | `on_notification` || Script |
28+
| dev scanner | 🔍 | On-network scanner discovering devices without a 3rd party service | `schedule` || Script / SQLite DB |
29+
| name discovery | 🆎 | Discovers names of devices via various protocols. | `before_name_updates`, `schedule` || Script |
30+
| importer | 📥 | Importing devices from another service. | `schedule` || Script / SQLite DB |
31+
| system || Providing core system functionality. | `schedule` / always on | ✖/✔ | Script / Template |
32+
| other || Other plugins | misc || Script / Template |
3333

3434
## Features
3535

36-
| Icon | Description |
37-
| ---- | ------------------------------------------------------------ |
38-
| 🖧 | Auto-imports the network topology diagram |
36+
| Icon | Description |
37+
| ---- | -------------------------------------------------------------- |
38+
| 🖧 | Auto-imports the network topology diagram |
3939
| 🔄 | Has the option to sync some data back into the plugin source |
4040

4141

@@ -48,46 +48,47 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T
4848
| `APPRISE` | [_publisher_apprise](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/_publisher_apprise/) | ▶️ | Apprise notification proxy | | |
4949
| `ARPSCAN` | [arp_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/arp_scan/) | 🔍 | ARP-scan on current network | | |
5050
| `AVAHISCAN` | [avahi_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/avahi_scan/) | 🆎 | Avahi (mDNS-based) name resolution | | |
51-
| `ASUSWRT` | [asuswrt_import](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/asuswrt_import/) | 🔍 | Import connected devices from AsusWRT | | |
51+
| `ASUSWRT` | [asuswrt_import](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/asuswrt_import/) | 📥 | Import connected devices from AsusWRT | | |
5252
| `CSVBCKP` | [csv_backup](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/csv_backup/) || CSV devices backup | | |
5353
| `CUSTPROP` | [custom_props](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/custom_props/) || Managing custom device properties values | | Yes |
5454
| `DBCLNP` | [db_cleanup](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/db_cleanup/) || Database cleanup | | Yes\* |
5555
| `DDNS` | [ddns_update](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/ddns_update/) || DDNS update | | |
56-
| `DHCPLSS` | [dhcp_leases](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/dhcp_leases/) | 🔍/📥/🆎 | Import devices from DHCP leases | | |
56+
| `DHCPLSS` | [dhcp_leases](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/dhcp_leases/) | 📥/🆎 | Import devices from DHCP leases | | |
5757
| `DHCPSRVS` | [dhcp_servers](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/dhcp_servers/) || DHCP servers | | |
5858
| `DIGSCAN` | [dig_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/dig_scan/) | 🆎 | Dig (DNS) Name resolution | | |
59-
| `FREEBOX` | [freebox](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/freebox/) | 🔍/♻/🆎 | Pull data and names from Freebox/Iliadbox | | |
60-
| `FRITZBOX` | [fritzbox](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/fritzbox/) | 🔍 | Fritz!Box device scanner via TR-064 | | |
59+
| `FREEBOX` | [freebox](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/freebox/) |📥/♻/🆎 | Pull data and names from Freebox/Iliadbox | | |
60+
| `FRITZBOX` | [fritzbox](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/fritzbox/) | 📥 | Fritz!Box device scanner via TR-064 | | |
6161
| `ICMP` | [icmp_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/icmp_scan/) || ICMP (ping) status checker | | |
6262
| `INTRNT` | [internet_ip](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/internet_ip/) | 🔍 | Internet IP scanner | | |
6363
| `INTRSPD` | [internet_speedtest](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/internet_speedtest/) || Internet speed test | | |
6464
| `IPNEIGH` | [ipneigh](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/ipneigh/) | 🔍 | Scan ARP (IPv4) and NDP (IPv6) tables | | |
65-
| `KEALSS` | [kea_api](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/kea_api/) | 🔍/🆎 | Pull lease data from the Kea DHCP API | | |
66-
| `LUCIRPC` | [luci_import](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/luci_import/) | 🔍 | Import connected devices from OpenWRT | | |
65+
| `KEALSS` | [kea_api](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/kea_api/) | 📥/🆎 | Pull lease data from the Kea DHCP API | | |
66+
| `LUCIRPC` | [luci_import](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/luci_import/) | 📥 | Import connected devices from OpenWRT | | |
6767
| `MAINT` | [maintenance](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/maintenance/) || Maintenance of logs, etc. | | |
68-
| `MQTT` | [_publisher_mqtt](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/_publisher_mqtt/) | ▶️ | MQTT for synching to Home Assistant | | |
68+
| `MQTT` | [_publisher_mqtt](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/_publisher_mqtt/) | ▶️ | MQTT for syncing to Home Assistant | | |
6969
| `MTSCAN` | [mikrotik_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/mikrotik_scan/) | 🔍 | Mikrotik device import & sync | | |
7070
| `NBTSCAN` | [nbtscan_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/nbtscan_scan/) | 🆎 | Nbtscan (NetBIOS-based) name resolution | | |
7171
| `NEWDEV` | [newdev_template](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/newdev_template/) || New device template | | Yes |
7272
| `NMAP` | [nmap_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/nmap_scan/) || Nmap port scanning & discovery | | |
73-
| `NMAPDEV` | [nmap_dev_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/nmap_dev_scan/) | 🔍 | Nmap dev scan on current network | | |
73+
| `NMAPDEV` | [nmap_dev_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/nmap_dev_scan/) | 🔍 | Nmap dev scan on current network | | |
7474
| `NSLOOKUP` | [nslookup_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/nslookup_scan/) | 🆎 | NSLookup (DNS-based) name resolution | | |
7575
| `NTFPRCS` | [notification_processing](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/notification_processing/) || Notification processing | | Yes |
7676
| `NTFY` | [_publisher_ntfy](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/_publisher_ntfy/) | ▶️ | NTFY notifications | | |
77-
| `OMDSDN` | [omada_sdn_imp](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/omada_sdn_imp/) | 📥/🆎 ❌ | UNMAINTAINED use `OMDSDNOPENAPI` | 🖧 🔄 | |
77+
| `OMDSDN` | [omada_sdn_imp](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/omada_sdn_imp/) | 📥/🆎 ❌ | UNMAINTAINED use `OMDSDNOPENAPI` | 🖧 🔄 | |
7878
| `OMDSDNOPENAPI` | [omada_sdn_openapi](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/omada_sdn_openapi/) | 📥/🆎 | OMADA TP-Link import via OpenAPI | 🖧 | |
79-
| `PIHOLE` | [pihole_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/pihole_scan/) | 🔍/🆎/📥 | Pi-hole device import & sync | | |
80-
| `PIHOLEAPI` | [pihole_api_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/pihole_api_scan/) | 🔍/🆎/📥 | Pi-hole device import & sync via API v6+ | | |
79+
| `PIHOLE` | [pihole_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/pihole_scan/) | 🆎/📥 | Pi-hole device import & sync | | |
80+
| `PIHOLEAPI` | [pihole_api_scan](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/pihole_api_scan/) | 🆎/📥 | Pi-hole device import & sync via API v6+ | | |
8181
| `PUSHSAFER` | [_publisher_pushsafer](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/_publisher_pushsafer/) | ▶️ | Pushsafer notifications | | |
8282
| `PUSHOVER` | [_publisher_pushover](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/_publisher_pushover/) | ▶️ | Pushover notifications | | |
83+
| `RSTIMPRT` | [rest_import](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/rest_import/) | 📥/🆎 | Import via a REST API endpoint | 🖧 | |
8384
| `SETPWD` | [set_password](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/set_password/) || Set password | | Yes |
8485
| `SMTP` | [_publisher_email](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/_publisher_email/) | ▶️ | Email notifications | | |
8586
| `SNMPDSC` | [snmp_discovery](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/snmp_discovery/) | 🔍/📥 | SNMP device import & sync | | |
86-
| `SYNC` | [sync](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/sync/) | 🔍/⚙/📥 | Sync & import from NetAlertX instances | 🖧 🔄 | Yes |
87+
| `SYNC` | [sync](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/sync/) | ⚙/📥 | Sync & import from NetAlertX instances | 🖧 🔄 | Yes |
8788
| `TELEGRAM` | [_publisher_telegram](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/_publisher_telegram/) | ▶️ | Telegram notifications | | |
8889
| `UI` | [ui_settings](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/ui_settings/) || UI specific settings | | Yes |
89-
| `UNFIMP` | [unifi_import](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/unifi_import/) | 🔍/📥/🆎 | UniFi device import & sync | 🖧 | |
90-
| `UNIFIAPI` | [unifi_api_import](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/unifi_api_import/) | 🔍/📥/🆎 | UniFi device import (SM API, multi-site) | | |
90+
| `UNFIMP` | [unifi_import](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/unifi_import/) | 📥/🆎 | UniFi device import & sync | 🖧 | |
91+
| `UNIFIAPI` | [unifi_api_import](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/unifi_api_import/) | 📥/🆎 | UniFi device import (SM API, multi-site) | | |
9192
| `VNDRPDT` | [vendor_update](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/vendor_update/) || Vendor database update | | |
9293
| `WEBHOOK` | [_publisher_webhook](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/_publisher_webhook/) | ▶️ | Webhook notifications | | |
9394
| `WEBMON` | [website_monitor](https://github.com/netalertx/NetAlertX/tree/main/front/plugins/website_monitor/) || Website down monitoring | | |
@@ -112,7 +113,8 @@ Plugins can be enabled via Settings, and can be disabled as needed.
112113
### Disabling, Unloading and Ignoring plugins
113114

114115
1. Change the `<prefix>_RUN` Setting to `disabled` if you want to disable the plugin, but keep the settings
115-
1. If you want to speed up the application, you can unload the plugin by unselecting it in the `LOADED_PLUGINS` setting.
116+
1. (Important) Save the settings
117+
1. (Optional) If you want to speed up the application, you can unload the plugin by unselecting it in the `LOADED_PLUGINS` setting (plugins have to be disabled first - see above steps).
116118
- Careful, once you save the Settings Unloaded plugin settings will be lost (old `app.conf` files are kept in the `/config` folder)
117119
1. You can completely ignore plugins by placing a `ignore_plugin` file into the plugin directory. Ignored plugins won't show up in the `LOADED_PLUGINS` setting.
118120

front/plugins/rest_import/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Enable **Generate Fake MAC** when the API does not expose MAC addresses (e.g. re
6363
```
6464

6565
**Configuration:**
66-
```
66+
```text
6767
Name: OPNsense DHCP
6868
URL: https://firewall/api/dnsmasq/leases/search
6969
Method: GET

0 commit comments

Comments
 (0)