Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jokob-sk/netalertx

💻🔍 WIFI / LAN intruder detector. Scans for devices connected to your network and alerts you if new and unknown devices are found.
https://github.com/jokob-sk/netalertx

arp-scan docker intrusion-detection network-analysis network-security networking pi-hole security selfhosted wifi-network wifi-security

Last synced: 7 days ago
JSON representation

💻🔍 WIFI / LAN intruder detector. Scans for devices connected to your network and alerts you if new and unknown devices are found.

Host: GitHub
URL: https://github.com/jokob-sk/netalertx
Owner: jokob-sk
License: gpl-3.0
Created: 2021-12-23T04:35:53.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-05-01T11:53:55.000Z (5 months ago)
Last Synced: 2024-05-01T16:15:40.047Z (5 months ago)
Topics: arp-scan, docker, intrusion-detection, network-analysis, network-security, networking, pi-hole, security, selfhosted, wifi-network, wifi-security
Language: HTML
Homepage:
Size: 180 MB
Stars: 1,702
Watchers: 14
Forks: 90
Open Issues: 16
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- Funding: FUNDING.yml
- License: LICENSE.txt

Awesome Lists containing this project

README

        [![GitHub Committed](https://img.shields.io/github/last-commit/jokob-sk/NetAlertX?color=40ba12&label=Committed&logo=GitHub&logoColor=fff&style=for-the-badge)](https://github.com/jokob-sk/NetAlertX)

[![Docker Size](https://img.shields.io/docker/image-size/jokobsk/netalertx?label=Size&logo=Docker&color=0aa8d2&logoColor=fff&style=for-the-badge)](https://hub.docker.com/r/jokobsk/netalertx)

[![Docker Pulls](https://img.shields.io/docker/pulls/jokobsk/netalertx?label=Pulls&logo=docker&color=0aa8d2&logoColor=fff&style=for-the-badge)](https://hub.docker.com/r/jokobsk/netalertx)

[![GitHub Release](https://img.shields.io/github/v/release/jokob-sk/NetAlertX?color=0aa8d2&logoColor=fff&logo=GitHub&style=for-the-badge)](https://github.com/jokob-sk/NetAlertX/releases)

[![Discord](https://img.shields.io/discord/1274490466481602755?color=0aa8d2&logoColor=fff&logo=Discord&style=for-the-badge)](https://discord.gg/UQnnHNYV)

# 🖧🔍 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](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins#readme) with auto-generated UI and in-build notification system. Build out and easily maintain your network source of truth (NSoT).

  | 🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/netalertx) |  📑 [Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) |🆕 [Release notes](https://github.com/jokob-sk/NetAlertX/releases) | 📚 [All Docs](https://github.com/jokob-sk/NetAlertX/tree/main/docs) | 

  |----------------------|----------------------| ----------------------|  ----------------------| 

  | ![Main screen][main] | ![device_details 1][device_details]  | ![Screen network][network] |

  |----------------------|----------------------| ----------------------| 

  ![network_setup][network_setup] 

Head to [https://netalertx.com/](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 NetAlert^x?

  


  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.

  NetAlert^x 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 🔐_. 

  NetAlert^x 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 NetAlert^x. 

  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](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins#readme) docs for more info on individual scans. |

|📧           | Send notifications to more than 80+ services, including Telegram via [Apprise](https://hub.docker.com/r/caronc/apprise), or use [Pushsafer](https://www.pushsafer.com/), [Pushover](https://www.pushover.net/), or [NTFY](https://ntfy.sh/). |

|🧩           | Feed your data and device changes into [Home Assistant](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HOME_ASSISTANT.md), read [API endpoints](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md), or use [Webhooks](https://github.com/jokob-sk/NetAlertX/blob/main/docs/WEBHOOK_N8N.md) to setup custom automation flows.  |

|➕           | Build your own scanners with the [Plugin system](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins#readme) |

## Installation & Documentation

| Docs        | Link    | 

|-------------|-------------|

| 📥🐳  | [Docker instructions](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) 

| 📥🗄️  | [HW install (experimental 🧪)](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) |

| 📥🟧  | [Unraid App](https://unraid.net/community/apps) |

| 📚     | [All Documentation](https://github.com/jokob-sk/NetAlertX/blob/main/docs/README.md) (App Usage and Configuration) |

 

> Other Alternatives

>

> - Check out [leiweibau's on HW installed fork](https://github.com/leiweibau/Pi.Alert/) (maintained)

> - [WatchYourLAN](https://github.com/aceberg/WatchYourLAN) - Lightweight network IP scanner with web GUI (Open source)

> - [Fing](https://www.fing.com/) - Network scanner app for your Internet security (Commercial, Phone App, Proprietary hardware)

> - [NetBox](https://netboxlabs.com/) - 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][follow_star] 

### ⭐ Sponsors

[![GitHub Sponsors](https://img.shields.io/github/sponsors/jokob-sk?style=social)](https://github.com/sponsors/jokob-sk)

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 [[email protected]](mailto:[email protected]?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](https://github.com/pucherot/Pi.Alert) (the original creator of PiAlert), [leiweibau](https://github.com/leiweibau/Pi.Alert): Dark mode (and much more), [Macleykun](https://github.com/Macleykun) (Help with Dockerfile clean-up) [Final-Hawk](https://github.com/Final-Hawk) (Help with NTFY, styling and other fixes), [TeroRERO](https://github.com/terorero) (Spanish translations), [Data-Monkey](https://github.com/Data-Monkey), (Split-up of the python.py file and more), [cvc90](https://github.com/cvc90) (Spanish translation and various UI work) to name a few...

## Everything else

### 🌍 Translations 

Proudly using [Weblate](https://hosted.weblate.org/projects/pialert/).



  



Help out and suggest languages in the [online portal of Weblate](https://hosted.weblate.org/projects/pialert/core/).

### License

>  GPL 3.0 | [Read more here](LICENSE.txt) | 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)

  

[main]:                     ./docs/img/devices_split.png                  "Main screen"

[device_details]:           ./docs/img/device_details.png                 "Screen 1"

[events]:                   ./docs/img/events.png                         "Screen 2"

[presence]:                 ./docs/img/presence.png                       "Screen 3"

[maintenance]:              ./docs/img/maintenance.png                    "Screen 4"

[network]:                  ./docs/img/network.png                        "Screen 5"

[settings]:                 ./docs/img/settings.png                       "Screen 6"

[network_setup]:            ./docs/img/network_setup.gif                  "Screen 6"

[help_faq]:                 ./docs/img/help_faq.png                       "Screen 7"

[sync_hub]:                 ./docs/img/sync_hub.png                       "Screen 8"

[notification_center]:      ./docs/img/notification_center.png            "Screen 8"

[sent_reports_text]:        ./docs/img/sent_reports_text.png              "Screen 8"

[device_nmap]:              ./docs/img/device_nmap.png                    "Screen 9"

[report1]:                  ./docs/img/report_sample.png                  "Report sample 1"

[main_dark]:                /docs/img/1_devices_dark.jpg                  "Main screen dark"

[maintain_dark]:            /docs/img/5_maintain.jpg                      "Maintain screen dark"

[follow_star]:              /docs/img/Follow_Releases_and_Star.gif        "Follow and Star"