README.md

Pi.Alert

💻🔍 WIFI / LAN intruder detector.

Scans for devices connected to your WIFI / LAN and alerts you if new and unknown devices are found.

🐳 Docker image

🐳 Docker hub | 📄 Dockerfile | 📚 Docker instructions

🔍 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:

• 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.

🧩 Notification Integrations

• Apprise, Pushsafer, NTFY
• Webhooks (sample JSON)
• (❗Experimental) Home Assistant via MQTT
  • discovery ~10s per device, deleting not supported, use MQTT Explorer for now

🔐 Security

• 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:
  • 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) and Light/Dark-Mode Switch
  • Language Selection (English, German, Spanish)
  • Pause arp-scan
  • DB maintenance, Backup, Restore tools and CSV Export / Import
• Help/FAQ Section

📥 Installation

⚠ This fork (jokob-sk) is only tested as a docker container. 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

🔗 Other

Alternatives

• WatchYourLAN - Lightweight network IP scanner with web GUI (Open source)
• Fing - Network scanner app for your Internet security (Commercial, Phone App, Proprietary hardware)

Old docs

• Device Management instructions
• Versions History

License

GPL 3.0

• Read more here
• Source of the animated GIF (Loading Animation)
• Source of the selfhosted Fonts

🥇 Special thanks

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

• 🏆 pucherot/Pi.Alert is the original creator od PiAlert
  • leiweibau: Dark mode (and much more)
  • Macleykun: Help with Dockerfile clean-up
  • Final-Hawk: Help with NTFY, styling and other fixes
  • TeroRERO: Spanish translation
  • jokob-sk: DB Maintenance tools
  • Please see the Git commit history for a full list of people and their contributions to the project