Automatic documentation update

This commit is contained in:
igorpecovnik
2025-04-28 09:46:27 +00:00
committed by Igor
parent f43aa33be6
commit a7fed35732
3 changed files with 152 additions and 0 deletions

View File

@@ -222,3 +222,79 @@ armbian-config --cmd PRO003
## NetAlertX
NetAlertX network scanner & notification framework
<!--- section image START from tools/include/images/NAX001.png --->
[![NetAlertX](/images/NAX001.png)](#)
<!--- section image STOP from tools/include/images/NAX001.png --->
<!--- header START from tools/include/markdown/NAX001-header.md --->
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/).
<!--- header STOP from tools/include/markdown/NAX001-header.md --->
**Author:** @armbian
**Status:** Stable
~~~ custombash
armbian-config --cmd NAX001
~~~
<!--- footer START from tools/include/markdown/NAX001-footer.md --->
=== "Access to the web interface"
The web interface is accessible via port **20211**:
- URL: `https://<your.IP>:20211`
=== "Directories"
- Config directory: `/armbian/netalertx/config`
=== "View logs"
```sh
docker logs -f netalertx
```
<!--- footer STOP from tools/include/markdown/NAX001-footer.md --->
~~~ bash title="NetAlertX network scanner remove:"
armbian-config --cmd NAX002
~~~
~~~ bash title="NetAlertX network scanner purge with data folder:"
armbian-config --cmd NAX003
~~~

View File

@@ -2059,6 +2059,82 @@ armbian-config --cmd PRO003
#### NetAlertX
NetAlertX network scanner & notification framework
<!--- section image START from tools/include/images/NAX001.png --->
[![NetAlertX](/images/NAX001.png)](#)
<!--- section image STOP from tools/include/images/NAX001.png --->
<!--- header START from tools/include/markdown/NAX001-header.md --->
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/).
<!--- header STOP from tools/include/markdown/NAX001-header.md --->
**Author:** @armbian
**Status:** Stable
~~~ custombash
armbian-config --cmd NAX001
~~~
<!--- footer START from tools/include/markdown/NAX001-footer.md --->
=== "Access to the web interface"
The web interface is accessible via port **20211**:
- URL: `https://<your.IP>:20211`
=== "Directories"
- Config directory: `/armbian/netalertx/config`
=== "View logs"
```sh
docker logs -f netalertx
```
<!--- footer STOP from tools/include/markdown/NAX001-footer.md --->
~~~ 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

BIN
docs/images/NAX001.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB