/Pi.Alert

πŸ’»πŸ” WIFI / LAN intruder detector. Scans for devices connected to your network and alerts you if new and unknown devices are found.

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

πŸ’»πŸ” Network security scanner & notification framework

Get visibility of what's going on on your WIFI/LAN network. Scan 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.

Docker GitHub Committed Docker Size Docker Pulls Docker Pushed

🐳 Docker hub πŸ“‘ Docker guide πŸ†• Release notes πŸ“š All Docs

Why 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 πŸ“¦. You get an overview of network device Sessions, Connected devices, Events, Presence, Down alerts, and IPs. You can schedule Nmap scans to detect changes in device ports and visualize your Network topology (even with undetectable, dummy devices).

Setup 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 ❀.

Main screen Screen 1 Screen 5
Screen 3 Screen 4 Screen 6
Screen 8 Report 2 Screen 9

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, 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

❀ Support me

Get:

  • Regular updates to keep your data and family safe πŸ”„
  • Better and more functionalityβž•
  • I don't get burned out and the app survives longerπŸ”₯🀯
  • Quicker and better support with issues πŸ†˜
  • Less grumpy me πŸ˜„
GitHub Buy Me A Coffee Patreon
  • Bitcoin: 1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM
  • Ethereum: 0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7

πŸ“§ Email me at jokob@duck.com if you want to get in touch or if I should add other sponsorship platforms.

Everything else

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

Please see the Git contributors for a full list of people and their contributions to the project