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 3 Packages Projects Releases Wiki Activity
Files
442323f2dcf26c876663c3e3bd1162070e501cc0
NetAlertX/README.md
Jokob-sk 442323f2dc mqtt prep 10 + readme cleanup
2022-12-04 17:57:21 +11:00

6.7 KiB
Executable File
Raw Blame History

Pi.Alert

💻🔍 WIFI / LAN intruder detector.

Scan the devices connected to your WIFI / LAN and alert you the connection of unknown devices. It also warns if a "always connected" devices disconnects.

Main screen

🐳 Docker image

Docker GitHub Committed Docker Size Docker Pulls Docker Pushed

🐳 Docker hub
📄 Dockerfile
📚 Docker instructions

Dark mode (and much more) within this fork courtesy of leiweibau

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

Up to three scanning methods are used:

  • Method 1: arp-scan. The arp-scan system utility is used to search for devices on the network using arp frames.
  • Method 2: Pi-hole. This method is optional and complementary to method 1. If the Pi-hole DNS server is active, Pi.Alert examines its activity looking for active devices using DNS that have not been detected by method 1.
  • 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

Report 1 Report 2

🔐 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. To change password run /home/pi/pialert/back/pialert-cli

📑 Features

  • Display in a visual way all the information collected by the back
    • Sessions, Connected devices, Favorites
    • Events, Presence, Concurrent devices
    • Down alerts
    • IP's
    • Manual Nmap scans, Optional speedtest for Device "Internet"
    • Simple Network relationship display
  • Maintenance tasks and Settings like:
    • Status Infos (active scans, database size, backup counter)
    • Theme Selection (blue, red, green, yellow, black, purple)
    • Language Selection (english, german, spanish)
    • Light/Dark-Mode Switch
    • Pause arp-scan
    • DB maintenance, Backup, Restore tools
    • CSV Export / Import
  • Help/FAQ Section
Screen 1 Screen 2
Screen 3 Screen 4
Screen 5 Screen 6

📥 Installation

⚠ Please note, this fork (jokob-sk) is only tested via the docker install method. Check out leiweibau's fork if you want to install Pi.Alert on the server directly.

Instructions for pucherot's original code can be found here

Device Management

Other useful info

Versions History

License

GPL 3.0 Read more here

Source of the animated GIF (Loading Animation) https://commons.wikimedia.org/wiki/File:Loading_Animation.gif

Source of the selfhosted Fonts https://github.com/adobe-fonts/source-sans

🥇 Special thanks

This code is a collaborative body of work, with special thanks to: