search

jokob-sk / NetAlertX

🖧🔍 WIFI / LAN intruder detector. Scans for devices connected to your network and alerts you if new and unknown devices are found.
GNU General Public License v3.0
3.12k stars 186 forks source link
arp-scan docker intrusion-detection ipam network-analysis network-security networking pi-hole security selfhosted wifi-network wifi-security

readme

GitHub Committed Docker Size Docker Pulls GitHub Release Discord

🖧🔍 Network 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).

🐳 Docker hub 📑 Docker guide 🆕 Release notes 📚 All Docs
Main screen device_details 1 Screen network

network_setup

Head to https://netalertx.com/ for more gifs and screenshots 📷.

📷 Click for more screenshots | ![presence][presence] | ![maintenance][maintenance] | ![settings][settings] | |----------------------|----------------------|----------------------| | ![sync_hub][sync_hub] | ![report1][report1] | ![device_nmap][device_nmap] |
❓ Why use NetAlertx?
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. NetAlertx 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 🔐_. NetAlertx 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](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HOME_ASSISTANT.md) integration. Implement custom automations with the [CSV device Exports 📤](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/csv_backup), [Webhooks](https://github.com/jokob-sk/NetAlertX/blob/main/docs/WEBHOOK_N8N.md), or [API endpoints](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md) features. Extend the app if you want to create your own scanner [Plugin](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins#readme) and handle the results and notifications in NetAlertx. 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

Supported browsers: Chrome, Firefox

Docs Link
📥🐳 Docker instructions
📥🗄️ HW install (experimental 🧪)
📥🟧 Unraid App
📚 All Documentation (App Usage and Configuration)

Other Alternatives

  • Check out leiweibau's on HW installed fork (maintained)
  • WatchYourLAN - Lightweight network IP scanner with web GUI (Open source)
  • Fing - Network scanner app for your Internet security (Commercial, Phone App, Proprietary hardware)
  • NetBox - Network management software (Commercial)

🔔 Get notified what's new

Get notified about a new release, what new functionality you can use and about breaking changes.

Follow and star

⭐ Sponsors

GitHub Sponsors

Thank you to all the wonderful people who are sponsoring this project.

preventing my burnout😅 are:

All Sponsors
Click for more ways to donate
| [![GitHub](https://i.imgur.com/emsRCPh.png)](https://github.com/sponsors/jokob-sk) | [![Buy Me A Coffee](https://i.imgur.com/pIM6YXL.png)](https://www.buymeacoffee.com/jokobsk) | [![Patreon](https://i.imgur.com/MuYsrq1.png)](https://www.patreon.com/user?u=84385063) | | --- | --- | --- | - Bitcoin: `1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM` - Ethereum: `0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7` 📧 Email me at [jokob@duck.com](mailto:jokob@duck.com?subject=NetAlertX) 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...

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