{"id":13582609,"url":"https://github.com/jokob-sk/NetAlertX","last_synced_at":"2025-04-06T14:31:11.653Z","repository":{"id":37067531,"uuid":"441062625","full_name":"jokob-sk/NetAlertX","owner":"jokob-sk","description":"🖧🔍 WIFI / LAN intruder detector.  Scans for devices connected to your network and alerts you if new and unknown devices are found.","archived":false,"fork":false,"pushed_at":"2024-10-29T11:53:49.000Z","size":196810,"stargazers_count":3009,"open_issues_count":19,"forks_count":182,"subscribers_count":21,"default_branch":"main","last_synced_at":"2024-10-29T13:33:00.940Z","etag":null,"topics":["arp-scan","docker","intrusion-detection","ipam","network-analysis","network-security","networking","pi-hole","security","selfhosted","wifi-network","wifi-security"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"pucherot/Pi.Alert","license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jokob-sk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING","funding":"FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"jokob-sk","patreon":84385063}},"created_at":"2021-12-23T04:35:53.000Z","updated_at":"2024-10-29T11:53:52.000Z","dependencies_parsed_at":"2023-02-16T19:31:24.791Z","dependency_job_id":"b36fd70a-4b0b-4245-909a-daca20dbe5f8","html_url":"https://github.com/jokob-sk/NetAlertX","commit_stats":{"total_commits":2992,"total_committers":94,"mean_commits":"31.829787234042552","dds":0.7249331550802138,"last_synced_commit":"a7f45659547669f99ad7bc4e6495a029327c8cb4"},"previous_names":["jokob-sk/netalertx"],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jokob-sk%2FNetAlertX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jokob-sk%2FNetAlertX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jokob-sk%2FNetAlertX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jokob-sk%2FNetAlertX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jokob-sk","download_url":"https://codeload.github.com/jokob-sk/NetAlertX/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247495804,"owners_count":20948110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arp-scan","docker","intrusion-detection","ipam","network-analysis","network-security","networking","pi-hole","security","selfhosted","wifi-network","wifi-security"],"created_at":"2024-08-01T15:02:52.714Z","updated_at":"2025-04-06T14:31:06.643Z","avatar_url":"https://github.com/jokob-sk.png","language":"HTML","funding_links":["https://github.com/sponsors/jokob-sk","https://patreon.com/84385063","https://www.buymeacoffee.com/jokobsk","https://www.patreon.com/user?u=84385063"],"categories":["置顶","JavaScript","Python","security"],"sub_categories":["05、运维监控体系"],"readme":"[![GitHub Committed](https://img.shields.io/github/last-commit/jokob-sk/NetAlertX?color=40ba12\u0026label=Pushed\u0026logo=GitHub\u0026logoColor=fff\u0026style=for-the-badge)](https://github.com/jokob-sk/NetAlertX)\n[![Docker Size](https://img.shields.io/docker/image-size/jokobsk/netalertx?label=Size\u0026logo=Docker\u0026color=0aa8d2\u0026logoColor=fff\u0026style=for-the-badge)](https://hub.docker.com/r/jokobsk/netalertx)\n[![Docker Pulls](https://img.shields.io/docker/pulls/jokobsk/netalertx?label=Pulls\u0026logo=docker\u0026color=0aa8d2\u0026logoColor=fff\u0026style=for-the-badge)](https://hub.docker.com/r/jokobsk/netalertx)\n[![GitHub Release](https://img.shields.io/github/v/release/jokob-sk/NetAlertX?color=0aa8d2\u0026logoColor=fff\u0026logo=GitHub\u0026style=for-the-badge)](https://github.com/jokob-sk/NetAlertX/releases)\n[![Discord](https://img.shields.io/discord/1274490466481602755?color=0aa8d2\u0026logoColor=fff\u0026logo=Discord\u0026style=for-the-badge)](https://discord.gg/NczTUTWyRr)\n\n# 🖧🔍 Network scanner \u0026 notification framework\n\nGet 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).\n\n\n  | 🐳 [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) | \n  |----------------------|----------------------| ----------------------|  ----------------------| \n\n\n  | ![Main screen][main] | ![device_details 1][device_details]  | ![Screen network][network] |\n  |----------------------|----------------------| ----------------------| \n\n  ![network_setup][network_setup] \n\n\nHead to [https://netalertx.com/](https://netalertx.com/) for more gifs and screenshots 📷.\n\n\u003cdetails\u003e\n  \u003csummary\u003e📷 Click for more screenshots\u003c/summary\u003e\n\n  | ![presence][presence] | ![maintenance][maintenance] | ![settings][settings]  |\n  |----------------------|----------------------|----------------------|\n  | ![sync_hub][sync_hub] | ![report1][report1] | ![device_nmap][device_nmap]  |\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e❓ Why use Net\u003cb\u003eAlert\u003c/b\u003e\u003csup\u003ex\u003c/sup\u003e?\u003c/summary\u003e\n\n  \u003chr\u003e\n\n  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.\n\n  Net\u003cb\u003eAlert\u003c/b\u003e\u003csup\u003ex\u003c/sup\u003e 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 🔐_. \n\n  Net\u003cb\u003eAlert\u003c/b\u003e\u003csup\u003ex\u003c/sup\u003e combines several network and other scanning tools 🔍 with notifications 📧 into one user-friendly package 📦. \n\n  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. \n\n  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 Net\u003cb\u003eAlert\u003c/b\u003e\u003csup\u003ex\u003c/sup\u003e. \n\n  Looking forward to your contributions if you decide to share your work with the community ❤.\n\n\u003c/details\u003e\n\n## Scan Methods, Notifications, Integration, Extension system\n\n| Features    | Details    | \n|-------------|-------------|\n|      🔍     |   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 \u0026 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. |\n|📧           | 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/). |\n|🧩           | 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.  |\n|➕           | Build your own scanners with the [Plugin system](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins#readme) |\n\n\n## Installation \u0026 Documentation\n\u003c!--- --------------------------------------------------------------------- ---\u003e\n\nSupported browsers: Chrome, Firefox\n\n| Docs        | Link    | \n|-------------|-------------|\n| 📥🐳  | [Docker instructions](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) \n| 📥🗄️  | [HW install (experimental 🧪)](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) |\n| 📥🟧  | [Unraid App](https://unraid.net/community/apps) |\n| 📚     | [All Documentation](https://github.com/jokob-sk/NetAlertX/blob/main/docs/README.md) (App Usage and Configuration) |\n \n\u003e Other Alternatives\n\u003e\n\u003e - Check out [leiweibau's on HW installed fork](https://github.com/leiweibau/Pi.Alert/) (maintained)\n\u003e - [WatchYourLAN](https://github.com/aceberg/WatchYourLAN) - Lightweight network IP scanner with web GUI (Open source)\n\u003e - [Fing](https://www.fing.com/) - Network scanner app for your Internet security (Commercial, Phone App, Proprietary hardware)\n\u003e - [NetBox](https://netboxlabs.com/) - Network management software (Commercial)\n\n## 🔔 Get notified what's new\n\nGet notified about a new release, what new functionality you can use and about breaking changes. \n\n![Follow and star][follow_star] \n\n### ⭐ Sponsors\n\n[![GitHub Sponsors](https://img.shields.io/github/sponsors/jokob-sk?style=social)](https://github.com/sponsors/jokob-sk)\n\nThank you to all the wonderful people who are sponsoring this project. \n\n\u003e preventing my burnout😅 are:\n\n\u003c!-- SPONSORS-LIST DO NOT MODIFY BELOW --\u003e\n| All Sponsors |\n|---|\n\n\u003c!-- SPONSORS-LIST DO NOT MODIFY ABOVE --\u003e\n\n\n\n\u003cdetails\u003e\n  \u003csummary\u003eClick for more ways to donate\u003c/summary\u003e\n  \n  \u003chr\u003e\n\n  | [![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) | \n| --- | --- | --- | \n\n  - Bitcoin: `1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM`\n  - Ethereum: `0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7`\n\n  📧 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.\n\n\u003c/details\u003e\n\n### 🙏Contributors\n\nThis project would be nothing without the amazing work of the community, with special thanks to: \n\n\u003e [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...\n\n\n## Everything else\n\u003c!--- --------------------------------------------------------------------- ---\u003e\n\n### 🌍 Translations \n\nProudly using [Weblate](https://hosted.weblate.org/projects/pialert/).\n\n\u003ca href=\"https://hosted.weblate.org/engage/pialert/\"\u003e\n  \u003cimg src=\"https://hosted.weblate.org/widget/pialert/core/multi-auto.svg\" alt=\"Translation status\" /\u003e\n\u003c/a\u003e\n\nHelp out and suggest languages in the [online portal of Weblate](https://hosted.weblate.org/projects/pialert/core/).\n\n### License\n\u003e  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)\n  \n\n\n\u003c!--- --------------------------------------------------------------------- ---\u003e\n[main]:                     ./docs/img/devices_split.png                  \"Main screen\"\n[device_details]:           ./docs/img/device_details.png                 \"Screen 1\"\n[events]:                   ./docs/img/events.png                         \"Screen 2\"\n[presence]:                 ./docs/img/presence.png                       \"Screen 3\"\n[maintenance]:              ./docs/img/maintenance.png                    \"Screen 4\"\n[network]:                  ./docs/img/network.png                        \"Screen 5\"\n[settings]:                 ./docs/img/settings.png                       \"Screen 6\"\n[network_setup]:            ./docs/img/network_setup.gif                  \"Screen 6\"\n[help_faq]:                 ./docs/img/help_faq.png                       \"Screen 7\"\n[sync_hub]:                 ./docs/img/sync_hub.png                       \"Screen 8\"\n[notification_center]:      ./docs/img/notification_center.png            \"Screen 8\"\n[sent_reports_text]:        ./docs/img/sent_reports_text.png              \"Screen 8\"\n[device_nmap]:              ./docs/img/device_nmap.png                    \"Screen 9\"\n[report1]:                  ./docs/img/report_sample.png                  \"Report sample 1\"\n[main_dark]:                /docs/img/1_devices_dark.jpg                  \"Main screen dark\"\n[maintain_dark]:            /docs/img/5_maintain.jpg                      \"Maintain screen dark\"\n[follow_star]:              /docs/img/Follow_Releases_and_Star.gif        \"Follow and Star\"\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjokob-sk%2FNetAlertX","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjokob-sk%2FNetAlertX","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjokob-sk%2FNetAlertX/lists"}