cphipps/NetAlertX
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Jokob-sk
2023-09-01 22:15:21 +10:00
parent a379054f5b
commit bed4e6a152
1 changed files with 7 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -17,17 +17,13 @@ Scans for devices connected to your WIFI / LAN and alerts you if new and unknown
🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/pi.alert) | 📑 [Docker guide](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md) | 🆕 [Release notes](https://github.com/jokob-sk/Pi.Alert/releases) | 📚 [All Docs](https://github.com/jokob-sk/Pi.Alert/tree/main/docs) 🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/pi.alert) | 📑 [Docker guide](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md) | 🆕 [Release notes](https://github.com/jokob-sk/Pi.Alert/releases) | 📚 [All Docs](https://github.com/jokob-sk/Pi.Alert/tree/main/docs)
## 🔍 Scan Methods ## 🔍 Scan Methods
The system continuously scans the network for, **New devices**, **New connections** (re-connections), **Disconnections**, **"Always Connected" devices down**, Devices **IP changes** and **Internet IP address changes**. Scanning methods are: The system continuously scans the network for, **New devices**, **New connections** (re-connections), **Disconnections**, **"Always Connected" devices down**, Devices **IP changes** and **Internet IP address changes**. Discovery & scan methods include:
- **Method 1: arp-scan**. The arp-scan system utility is used to search - **arp-scan**. The arp-scan system utility is used to search for devices on the network using arp frames.
for devices on the network using arp frames. - **Pi-hole - DB import**. The PiHole database is used as a source for events for devices
- **Method 2: Pi-hole**. This method is optional and complementary to - **Pi-hole - DHCP leases**. Import of devices from the PiHole dhcp.leases file
method 1. If the Pi-hole DNS server is active, Pi.Alert examines its - **Generic DHCP leases**. Import of devices from the generic dhcp.leases file
activity looking for active devices using DNS that have not been - **UNIFI import**. Import of devices from the UNIFI controller
detected by method 1. - **SNMP-enabled router import**. Import of devices from an SNMP enabled router
- **Method 3. dnsmasq**. This method is optional and complementary to the
previous methods. If the DHCP server dnsmasq is active, Pi.Alert
examines the DHCP leases (addresses assigned) to find active devices
that were not discovered by the other methods.
## 🧩 Integrations ## 🧩 Integrations
- [Apprise](https://hub.docker.com/r/caronc/apprise), [Pushsafer](https://www.pushsafer.com/), [NTFY](https://ntfy.sh/) - [Apprise](https://hub.docker.com/r/caronc/apprise), [Pushsafer](https://www.pushsafer.com/), [NTFY](https://ntfy.sh/)