vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 09:36:05 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated FREEBOX documentation to mention the Iliadbox gateway

Browse Source
This commit is contained in:
Alvise Bruniera
2024-12-02 00:17:32 +01:00
parent ae2f898b39
commit 12f2d12d52
2 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
front/plugins/README.md
View File

@@ -24,7 +24,7 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T
| ID | Type | Description | Features | Required | Data source | Detailed docs | | ID | Type | Description | Features | Required | Data source | Detailed docs |
| ----------- | ----- | ------------------------------------------ | -------- | -------- | ----------- | ------------------------------------------------------------------ | | ----------- | ----- | --------------------------------------------------- | -------- | -------- | ----------- | ------------------------------------------------------------------ |
| `APPRISE` | ▶️ | Apprise notification proxy | | | Script | [_publisher_apprise](/front/plugins/_publisher_apprise/) | | `APPRISE` | ▶️ | Apprise notification proxy | | | Script | [_publisher_apprise](/front/plugins/_publisher_apprise/) |
| `ARPSCAN` | 🔍 | ARP-scan on current network | | | Script | [arp_scan](/front/plugins/arp_scan/) | | `ARPSCAN` | 🔍 | ARP-scan on current network | | | Script | [arp_scan](/front/plugins/arp_scan/) |
| `AVAHISCAN` | ♻ | Avahi (mDNS-based) name resolution | | | Script | [avahi_scan](/front/plugins/avahi_scan/) | | `AVAHISCAN` | ♻ | Avahi (mDNS-based) name resolution | | | Script | [avahi_scan](/front/plugins/avahi_scan/) |
@@ -58,7 +58,7 @@ Device-detecting plugins insert values into the `CurrentScan` database table. T
| `VNDRPDT` | ⚙ | Vendor database update | | | Script | [vendor_update](/front/plugins/vendor_update/) | | `VNDRPDT` | ⚙ | Vendor database update | | | Script | [vendor_update](/front/plugins/vendor_update/) |
| `WEBHOOK` | ▶️ | Webhook notifications | | | Script | [_publisher_webhook](/front/plugins/_publisher_webhook/) | | `WEBHOOK` | ▶️ | Webhook notifications | | | Script | [_publisher_webhook](/front/plugins/_publisher_webhook/) |
| `WEBMON` | ♻ | Website down monitoring | | | Script | [website_monitor](/front/plugins/website_monitor/) | | `WEBMON` | ♻ | Website down monitoring | | | Script | [website_monitor](/front/plugins/website_monitor/) |
| `FREEBOX` | 🔍/♻ | Pull data and names from a Freebox gateway | | | Script | [freebox](/front/plugins/freebox/) | | `FREEBOX` | 🔍/♻ | Pull data and names from a Freebox/Iliadbox gateway | | | Script | [freebox](/front/plugins/freebox/) |
> \* The database cleanup plugin (`DBCLNP`) is not _required_ but the app will become unusable after a while if not executed. > \* The database cleanup plugin (`DBCLNP`) is not _required_ but the app will become unusable after a while if not executed.
> >

4
front/plugins/freebox/README.md
View File

@@ -1,6 +1,6 @@
## Overview ## Overview
Plugin to pull devices, IPs, and their names from a Freebox gateway. Plugin to pull devices, IPs, and their names from a Freebox or Iliadbox gateway.
### Pairing ### Pairing
@@ -21,7 +21,7 @@ Note: You can screen and revoke any previous authorization (completed or attempt
Note: read [pairing](#pairing) first. Note: read [pairing](#pairing) first.
By default the plugin will connect to the address `mafreebox.freebox.fr` on the HTTPS port `443`. This will work in most cases, but has some limitations. By default the plugin will connect to the address `mafreebox.freebox.fr` on the HTTPS port `443`, if you have an Iliadbox, replace the address with `myiliadbox.iliad.it`. This will work in most cases, but has some limitations.
Limitations: Limitations:
- It requires internet access - It requires internet access