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

Update README.md

Browse Source
This commit is contained in:
jokob-sk
2022-12-04 20:57:00 +11:00
committed by GitHub
parent 33f981d4f9
commit 4f7268dae9
1 changed files with 17 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@@ -23,17 +23,8 @@ unknown devices. It also warns if a "always connected" devices disconnects.
Dark mode (and much more) within this fork courtesy of [leiweibau](https://github.com/leiweibau/Pi.Alert) Dark mode (and much more) within this fork courtesy of [leiweibau](https://github.com/leiweibau/Pi.Alert)
## How it works
The system continuously scans the network for:
- New devices
- New connections (re-connections)
- Disconnections
- "Always Connected" devices down
- Devices IP changes
- Internet IP address changes
## 🔍 Scan Methods ## 🔍 Scan Methods
Up to three scanning methods are used: 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:
- **Method 1: arp-scan**. The arp-scan system utility is used to search - **Method 1: 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.
- **Method 2: Pi-hole**. This method is optional and complementary to - **Method 2: Pi-hole**. This method is optional and complementary to
@@ -46,49 +37,44 @@ Up to three scanning methods are used:
that were not discovered by the other methods. that were not discovered by the other methods.
### 🧩 Integrations ### 🧩 Notification Integrations
- [Apprise](https://hub.docker.com/r/caronc/apprise) - [Apprise](https://hub.docker.com/r/caronc/apprise), [Pushsafer](https://www.pushsafer.com/), [NTFY](https://ntfy.sh/)
- [Pushsafer](https://www.pushsafer.com/)
- [NTFY](https://ntfy.sh/)
- Webhooks ([sample JSON](docs/webhook_json_sample.json)) - Webhooks ([sample JSON](docs/webhook_json_sample.json))
- (❗Experimental) Home Assistant (via [MQTT](https://www.home-assistant.io/integrations/mqtt/) (processing ~5s per device, deleting not supported, use [MQTT Explorer](https://mqtt-explorer.com/) for now)) - (❗Experimental) Home Assistant via [MQTT](https://www.home-assistant.io/integrations/mqtt/)
- discovery ~10s per device, deleting not supported, use [MQTT Explorer](https://mqtt-explorer.com/) for now
| ![Report 1][report1] | ![Report 2][report2] |
| -------------------- | -------------------- |
### 🔐 Security ### 🔐 Security
There is a configurable login to prevent unauthorized use.
> * Set `PIALERT_WEB_PROTECTION = True` in `pialert.conf` to enable. The default password is `123456`. - Configurable login to prevent unauthorized use.
> To change password run `/home/pi/pialert/back/pialert-cli` - Set `PIALERT_WEB_PROTECTION = True` in `pialert.conf` to enable.
- The default password is `123456`.
- To change password run `/home/pi/pialert/back/pialert-cli`
## 📑 Features ## 📑 Features
- Display in a visual way all the information collected by the back - Display:
- Sessions, Connected devices, Favorites - Sessions, Connected devices, Favorites, Events, Presence, Concurrent devices, Down alerts, IP's
- Events, Presence, Concurrent devices
- Down alerts
- IP's
- Manual Nmap scans, Optional speedtest for Device "Internet" - Manual Nmap scans, Optional speedtest for Device "Internet"
- Simple Network relationship display - Simple Network relationship display
- Maintenance tasks and Settings like: - Maintenance tasks and Settings like:
- Status Infos (active scans, database size, backup counter) - Status Infos (active scans, database size, backup counter)
- Theme Selection (blue, red, green, yellow, black, purple) - Theme Selection (blue, red, green, yellow, black, purple) and Light/Dark-Mode Switch
- Language Selection (english, german, spanish) - Language Selection (English, German, Spanish)
- Light/Dark-Mode Switch
- Pause arp-scan - Pause arp-scan
- DB maintenance, Backup, Restore tools - DB maintenance, Backup, Restore tools and CSV Export / Import
- CSV Export / Import
- Help/FAQ Section - Help/FAQ Section
| ![Screen 1][screen1] | ![Screen 2][screen2] | | ![Screen 1][screen1] | ![Screen 2][screen2] |
| -------------------- | -------------------- | | -------------------- | -------------------- |
| ![Screen 3][screen3] | ![Screen 4][screen4] | | ![Screen 3][screen3] | ![Screen 4][screen4] |
| ![Screen 5][screen5] | ![Screen 6][screen6] | | ![Screen 5][screen5] | ![Screen 6][screen6] |
| ![Report 1][report1] | ![Report 2][report2] |
# 📥 Installation # 📥 Installation
<!--- --------------------------------------------------------------------- ---> <!--- --------------------------------------------------------------------- --->
⚠ Please note, this [fork (jokob-sk)](https://github.com/jokob-sk/Pi.Alert) is only tested via the [docker install method](dockerfiles/README.md). Check out [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) if you want to install Pi.Alert on the server directly. ⚠ This [fork (jokob-sk)](https://github.com/jokob-sk/Pi.Alert) is only tested via the [docker install method](dockerfiles/README.md). Check out [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) if you want to install Pi.Alert on the server directly.
Instructions for [pucherot's original code can be found here](https://github.com/pucherot/Pi.Alert/) Instructions for [pucherot's original code can be found here](https://github.com/pucherot/Pi.Alert/)