Skip to content
forked from jokob-sk/Pi.Alert

⚠The active project has been renamed to NetAlertX and moved: jokob.sk/NetAlertX

License

Notifications You must be signed in to change notification settings

alexpi4/Pi.Alert

 
 

Repository files navigation

Important

⚠ This is a public archive and the active project has been renamed to NetAlertX and moved: jokob.sk/NetAlertX

  • To differentiate from the upstream stale project
  • To differentiate from other active forks
  • To indicate this is not a Raspberry Pi-specific tool anymore

💻🔍 Network security scanner & notification framework

Get visibility of what's going on on your WIFI/LAN network. Schedule scans for devices, port changes and get alerts if unknown devices or changes are found. Write your own Plugins with auto-generated UI and in-build notification system. Build out and easily maintain your network source of truth (NSoT).

GitHub Committed Docker Size Docker Pulls GitHub Release GitHub Sponsors

🐳 Docker hub 📑 Docker guide 🆕 Release notes 📚 All Docs
Main screen Screen 1 Screen 5
📷 Click for more screenshots
Screen 3 Screen 4 Screen 6
Screen 8 Report 2 Screen 9
❓ Why use PiAlert?

Most of us don't know what's going on on our home network, but we want our family and data to be safe. Command-line tools are great, but the output can be hard to understand and action if you are not a network specialist.

PiAlert gives you peace of mind. Visualize and immediately report 📬 what is going on in your network - this is the first step to enhance your network security 🔐.

PiAlert combines several network and other scanning tools 🔍 with notifications 📧 into one user-friendly package 📦.

Set up a kill switch ☠ for your network via a smart plug with the available Home Assistant integration. Implement custom automations with the CSV device Exports 📤, Webhooks, or API endpoints features.

Extend the app if you want to create your own scanner Plugin and handle the results and notifications in PiAlert.

Looking forward to your contributions if you decide to share your work with the community ❤.

Scan Methods, Notifications, Integration, Extension system

Features Details
🔍 The app scans your 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: arp-scan. Pi-hole - DB import, Pi-hole - DHCP leases import, Generic DHCP leases import. UNIFI controller import, SNMP-enabled router import. Check the Plugins docs for more info on individual scans.
📧 Send notifications to more than 80+ services, including Telegram via Apprise, or use Pushsafer, Pushover, or NTFY.
🧩 Feed your data and device changes into Home Assistant, read API endpoints, or use Webhooks to setup custom automation flows.
Build your own scanners with the Plugin system

Installation & Documentation

Docs Link
📥🐳 Docker instructions
📥💻 HW install (experimental 🧪)
📚 All Documentation (App Usage and Configuration)

Other Alternatives

⭐ Sponsors

GitHub Sponsors

Thank you to all the wonderful people who are sponsoring this project (=preventing my burnout🔥🤯):

All Sponsors
Tony Hanratty
GitHub Buy Me A Coffee Patreon
Click for more ways to donate
  • Bitcoin: 1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM
  • Ethereum: 0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7

📧 Email me at [email protected] if you want to get in touch or if I should add other sponsorship platforms.

🙏Contributors

This project would be nothing without the amazing work of the community, with special thanks to:

pucherot/Pi.Alert (the original creator of PiAlert), leiweibau: Dark mode (and much more), Macleykun (Help with Dockerfile clean-up) Final-Hawk (Help with NTFY, styling and other fixes), TeroRERO (Spanish translations), Data-Monkey, (Split-up of the python.py file and more), cvc90 (Spanish translation and various UI work) to name a few...

Here is everyone that helped and contributed to this project:

Everything else

🌍 Translations

Proudly using Weblate.

Translation status

Help out and suggest languages in the online portal of Weblate.

License

GPL 3.0 | Read more here | Source of the animated GIF (Loading Animation) | Source of the selfhosted Fonts

About

⚠The active project has been renamed to NetAlertX and moved: jokob.sk/NetAlertX

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 43.6%
  • Python 14.7%
  • JavaScript 14.1%
  • PHP 12.6%
  • Less 8.6%
  • CSS 5.5%
  • Other 0.9%