From a7fed357320d37d8be3b4709aec0538e161f4682 Mon Sep 17 00:00:00 2001 From: igorpecovnik <6281704+igorpecovnik@users.noreply.github.com> Date: Mon, 28 Apr 2025 09:46:27 +0000 Subject: [PATCH] `Automatic` documentation update --- .../User-Guide_Armbian-Software/Monitoring.md | 76 ++++++++++++++++++ docs/User-Guide_Armbian-Software/Software.md | 76 ++++++++++++++++++ docs/images/NAX001.png | Bin 0 -> 4168 bytes 3 files changed, 152 insertions(+) create mode 100644 docs/images/NAX001.png 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 0000000000000000000000000000000000000000..58a5030ae6b8a264b4df612833670bd31533d487 GIT binary patch literal 4168 zcmeAS@N?(olHy`uVBq!ia0y~yU^oH79Lx+1471we)-W(Iy$kROab>^&S70K)fB%Lt z8NPk{24@pwaB+d`J%gd{GLpyz7`umo;Q|=J1Q7IcFcYHd5}3`vz;Ka)0V2Y{z;O8R z;qzc|8ylOm3=9x85E3j5BF-@|oQ0Wx3?u-;mlzmMfsMLy<;w5hzrTL{dWwNzCrE~2 zDFee528O+0*=yIX9b#bEvSmvQn5(F$c#(nO<;#~ZUc9({`}Rc!hUE+l#~2vy-o3jH z9KKf=7%pGFe3gM=E!dG(3=E$?f8Ni)@afa1POz~zZ{FO%z_4rAuG6PaFJHd=%a<>n zo}S;ofB*XR>zg-ko;-Q-<;#~vix$8C|Mcn83}9XV|NjpR41DzH5hEkxr%#_Q zGB7M!wCFt8ia&q;EMZ{y_wV0_4eL@+Rf zGBEu3@uRD&tF^VYxVTtGM&=p=!vO|{tqcrR3=E|V4Bx+hcXD##;NY0Yz>vqlaP{id zdGqGg)zwv3S4Txf9bsVTW?*P!U@&7~P+(w?W?(pX?%c6s$2M=?JZsjhY15`nm@pwR zG11-KeJ=yUbOwfY28K8W24MyUUIvDD@7}$5@#5C4TNxP{p`oFEetyRo7$!0>_%Sf( zGcaf{Fnsy)<=(w}M-Cs($;t8d_CCbGkjTIg#J~^$j;#Fr{0kQ@Y}>YN&6+hPCMF9P zE^IU~u;t{mW?`B3Tww+}iT=!Z(-c&XyNjwO{wXJyH~s zAJyA;;7rM_%FEZ5%$F8FVgCMao&FXLWe9L~@pX1T|9h4D{OIT}75u)r;kQ4V=gWUD zF`?W_b8!k4#bj(cJusigLj!MiXcV~^SR&KX;eTk5(z5aZa z)RdrI*Ux8}M(kU5@7l#Hxf`YKo))w1K6&BFw!X3jAuB5Xe5#wwHhJ;I?aPwhl`6+d z`OH|BnP6~o`K92izeKbbZm-sunf(7KG#{d>ypD{uU-*#$uxw(5(<9J#8$<8i>8e~jDr zcEqo?w&^mLx_(;SluNNOV7k?|_YwX*_#E_+XGyPEM48{cu{K`C&GmTwxkJqaO2M5n6T$fX2 zGw-aZy6|7i#_FxSfoGStPp~=OcPRf|h1aqhqLa@GaGYUx-uF@?KBLr5z~F{YnT=?8 zyL6p(70=0_c$WGdOYZ62N{NX5uv<-eLwn)jT`#!TN!jGgkqvbH>e0qLRqMxT-K9tJ zxPQeyR249@-uX0s!wuE5$IbpMU1ifCRHo+7`#<7y*Ypi%X5?R#YP^xQHrh`5u-A;@ zzF$dVUKe_I<@^v&HM^)JYV3IZiH?WM*|xjfa&4k_cW>}6yUROe#^Im|9Ne?V%@P5i*j4Vs@N0xuWoHQ zrlS2{;e34A%nx>FVhngXqwZ~5v%%)~DW2c5XS`Ec^LSn+nc^9nCATm!uB+Vb!R|h{ zp6%%JB@8TWDxV7!& z@Ba_V`slk^Xl_w|elt^2&%@B)>-n@h0=GX`c$pW=8tBcZzHD!ws)Cl#t(5w*0EJgs zwv*Nv@F&gqdj5u5gGtt{l*d*rF*+_mvgcYOl)9xCFl=tQKdU<8(<@u<%(rWTqP&eS>$2%M8-H=6;M4^VquL6MtuamEZ(}jajo24f&tX zIlG@xMP#mfQdhB~Ue-0)8HpPNZdqfD$j_iWy(5m@_AlU zWoY%@(Wg6Mt&(?!%e$tWFi+JtbGVwlU(DxbylbA_k# z8lhWT_VTc-@KcWKJ*v?BMd;RRGbX{Ky?-{>37*&>C2^5YTtMl=+3JVB3Mq#Ubd=~Y zX-;kJ@Q;+Apb+QOKlydTKBFVg4>?Zg*A{$Hz-W1s{m1laQXCJwDy;7~O!y`CDA-A@ zWp>59K3N6N*sdQTD;hWsPM;`eEZwLQYW--kyH-oJ|CF~3p>mHtPl({i=gd{U%eZQD zhrcE3lQ*-4k8NXKvhtMR{KX;@j=j}8wu$XX;BtZak7GDK3LV?T{3P&fN57bbiuaDs z3cZ(a zdpOva%$wjcakln7mk%wckN(YJel^)3-|F=2O#VN9cOJ|)zyI4~mS+328NV!S8=pN` zQ?q4Rep=eTMV2fR9y=JHsXNhibD^M#tL=%83pnlep6*Io`9yQpLa`?%9w+W3xt~1i znc~mYILG&mbDFr7kM_hr3d<)}p7^r6=SM$hu~Mt!xjep^T4!oCN(GvaTAvWxF8yT7 zMqbS?`XvH4@2DSBox}g6WCO3_^Ta65>x@O$jCf}%ef}8lDH!=kNkRR9vT(||>C<_P z?yB$MezL`wXJ+jj!PK))CdwwVpXfAQP`IQysUy+Tndiw7>4_6FFC}JqTKH9pbKabx zBwLg=<80@7ze-=JNR2PSRyXpG-LsnTm`8!R_4|_MXK%yJR2e5+kLy1+@$-Vye8!p| zw*<%AxEy}w(VldYLrQ$x#dvAMtXI*!E4=cAct5i_&NFUe^R-u&P37rZ7$~S7u%m>Z z^JPHpv5Zc2P7~`x8An83ZdjzUhdCqa+5*PnCC+mXo@9FEW|x}&$1v%k?aP4IZ#x>J zXY@10Uh20JwYzNnLj04%N4-~1@AH*x47=jF@NjLu!$OzuGq)UdbX?xB>x=#JvL*3< zb)LOYRknKW@`6=W&;FI6`+JFsO6m7@vP;f;%9Vapcl116cO~)F&)TfxlW%uasM{Z@ zGTwH}F;G2K{nZ2T41*t(E@oJ*Gc< zyuQ<>*01O%=M}dPj+TvVR~CI}yZ5lJRJzmJ|7H304@-{KUJ__1dNs>ZFY#obWE^;-XY#9Z zo9P@)Tzi>TUHSiU-zB*iw?bpS{)JIa@+%TQduv(0>(#ou+epMb+3&60L?Od~!#k&i z-!xpeuldfQW9G{HuW_!ru`A>)zpkvy!3xjCyjKd{EJeSIz6`k0+_LMe#j>PFKQ*2@ zeA!bUSm83C-+Za_*)*9G_D71g)JWd7^1sPv`g=~mUdhXopL)Hz-dI&AuNCxe!iE^n ziw>Rod{R5gw9dC5`rkQ)@9J#Bx#4#{&W>5&I``7=pYz}MX5DI*GJkxanR7`|&N^n_ zpxYK<-`71m`(s)ick%9^1s8V-Y(4DzmwTR#%hgZjFSmcl=6u?Etud@LTV~4hu3Hm- z7QDW$`*q({jVUMI3m>0lb>WQIv#0M?zkjUcTV}Gh)mmB0CblU3bZhPcXCoEe+w!*Y z9_=gHj!m2HVYT1t^39hK_YAe7RQA>!x2~GIpnGrcan-8034E8&KIeZZR5M$)WK-)> z)z6MrYbL~5sSBk#T&Z6v_fkS!*Yv|LJ)zmxq<>}QZ}PoYQ`jvgt+w5uZI)RBSaGKdRp}V+>y(f?9NTHefH<4E|p!9Qs^fm>u8{HO--j{$I&i{I1RxXLxVHdv^;FD zl~4HJ%J1p4npa}O+IK$@VvFGiC@z(Yx0t2-;)!&&YXNP(e^;Z_m#zqp5AfyWZyk0S=_Zd*5WF!nngvj zyyQ=xcgrN({z)Hwv+ptcL6P+DG3x}yd+*PBW$tP?T~z#Pj8%cynM<`L?+?9~{QEK3 zDfrIJSe=vaY;WDp+X%gvcFLm;bfi$iKI zZ^dq#jE?1}rEhSBDqOujt6+g&)BdgctXB{1+q+&@aY0(2OZ58HtgF0gs)OA(FEfqY zy>@YCt-z`Ywo`Ln-MF?OOGj$&#FSHfp{FyqZ{7WC&soLB=UytFhwQ!Vi&Se~HhucG z^H#2-ddS|j-x745cCGvLmjAc;wQJTYCj;YmUzET1K3cSNX_8}gXiT7X*qVrqNk_Z1 azDfVE{t$0%?cN9K279{txvX