diff --git a/docs/User-Guide_Armbian-Software/Monitoring.md b/docs/User-Guide_Armbian-Software/Monitoring.md index 8f2c5e08..21e540c9 100644 --- a/docs/User-Guide_Armbian-Software/Monitoring.md +++ b/docs/User-Guide_Armbian-Software/Monitoring.md @@ -222,3 +222,79 @@ armbian-config --cmd PRO003 + +## NetAlertX + + +NetAlertX network scanner & notification framework + + + +[![NetAlertX](/images/NAX001.png)](#) + + + + +NetAlertX is an open-source network monitoring and intruder detection tool designed to provide visibility into your Wi-Fi or LAN network. It scans your network for connected devices and alerts you when new or unknown devices are detected, helping you monitor unauthorized access and maintain network security. + +**Key Features:** + +- **Scheduled Network Scans:** Regularly scans your network to detect new devices, reconnections, disconnections, and changes in IP addresses. + +- **Extensive Notification Support:** Integrates with over 80 notification services, including email, Telegram, Pushover, and NTFY, ensuring you receive timely alerts about network changes. + +- **Network Visualization:** Offers a user-friendly interface to visualize your entire network, enhancing security and simplifying management. + +- **Multi-Network Monitoring:** Supports synchronization of multiple network instances, providing cross-network visibility across various device manufacturers. + +- **Home Assistant Integration:** Seamlessly integrates with Home Assistant, enabling advanced automation workflows and smart home integrations. + +- **Customizable Plugins:** Allows users to develop custom plugins with auto-generated user interfaces and built-in notification systems, tailoring the tool to specific network monitoring needs. + +NetAlertX is actively maintained and supports various installation methods, including Docker and bare-metal setups. It serves as a proactive solution for maintaining network health and preventing issues before they escalate, providing peace of mind for individuals and small businesses alike. + +For more information and installation guides, visit the official [NetAlertX documentation](https://jokob-sk.github.io/NetAlertX/). + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd NAX001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **20211**: + + - URL: `https://:20211` + +=== "Directories" + + - Config directory: `/armbian/netalertx/config` + +=== "View logs" + + ```sh + docker logs -f netalertx + ``` + + + + +~~~ bash title="NetAlertX network scanner remove:" +armbian-config --cmd NAX002 +~~~ + + +~~~ bash title="NetAlertX network scanner purge with data folder:" +armbian-config --cmd NAX003 +~~~ + + + diff --git a/docs/User-Guide_Armbian-Software/Software.md b/docs/User-Guide_Armbian-Software/Software.md index a8dcfa0d..b87c49f7 100644 --- a/docs/User-Guide_Armbian-Software/Software.md +++ b/docs/User-Guide_Armbian-Software/Software.md @@ -2059,6 +2059,82 @@ armbian-config --cmd PRO003 +#### NetAlertX + + +NetAlertX network scanner & notification framework + + + +[![NetAlertX](/images/NAX001.png)](#) + + + + +NetAlertX is an open-source network monitoring and intruder detection tool designed to provide visibility into your Wi-Fi or LAN network. It scans your network for connected devices and alerts you when new or unknown devices are detected, helping you monitor unauthorized access and maintain network security. + +**Key Features:** + +- **Scheduled Network Scans:** Regularly scans your network to detect new devices, reconnections, disconnections, and changes in IP addresses. + +- **Extensive Notification Support:** Integrates with over 80 notification services, including email, Telegram, Pushover, and NTFY, ensuring you receive timely alerts about network changes. + +- **Network Visualization:** Offers a user-friendly interface to visualize your entire network, enhancing security and simplifying management. + +- **Multi-Network Monitoring:** Supports synchronization of multiple network instances, providing cross-network visibility across various device manufacturers. + +- **Home Assistant Integration:** Seamlessly integrates with Home Assistant, enabling advanced automation workflows and smart home integrations. + +- **Customizable Plugins:** Allows users to develop custom plugins with auto-generated user interfaces and built-in notification systems, tailoring the tool to specific network monitoring needs. + +NetAlertX is actively maintained and supports various installation methods, including Docker and bare-metal setups. It serves as a proactive solution for maintaining network health and preventing issues before they escalate, providing peace of mind for individuals and small businesses alike. + +For more information and installation guides, visit the official [NetAlertX documentation](https://jokob-sk.github.io/NetAlertX/). + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd NAX001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **20211**: + + - URL: `https://:20211` + +=== "Directories" + + - Config directory: `/armbian/netalertx/config` + +=== "View logs" + + ```sh + docker logs -f netalertx + ``` + + + + +~~~ bash title="NetAlertX network scanner remove:" +armbian-config --cmd NAX002 +~~~ + + +~~~ bash title="NetAlertX network scanner purge with data folder:" +armbian-config --cmd NAX003 +~~~ + + + + ## Remote File & Management tools #### Cockpit diff --git a/docs/images/NAX001.png b/docs/images/NAX001.png new file mode 100644 index 00000000..58a5030a Binary files /dev/null and b/docs/images/NAX001.png differ