From c6adaf99f4974a6642b38fd334e1c2d363960cb5 Mon Sep 17 00:00:00 2001 From: jokob-sk Date: Sun, 9 Feb 2025 12:01:02 +1100 Subject: [PATCH] MKDocs --- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/ISSUE_TEMPLATE/i-have-an-issue.yml | 2 +- README.md | 2 +- dockerfiles/README.md | 2 +- docs/DEV_ENV_SETUP.md | 12 ++-- docs/FRONTEND_DEVELOPMENT.md | 2 +- docs/INITIAL_SETUP.md | 2 + docs/INSTALLATION.md | 11 ++- docs/PLUGINS_DEV.md | 10 +-- docs/SETTINGS_SYSTEM.md | 2 +- docs/img/NetAlertX_logo.png | Bin 0 -> 6753 bytes docs/index.md | 77 +++++++++++++++++---- front/php/templates/footer.php | 2 +- mkdocs.yml | 18 +++-- 14 files changed, 104 insertions(+), 40 deletions(-) create mode 100755 docs/img/NetAlertX_logo.png diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 719aabc0..317a0a34 100755 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -46,7 +46,7 @@ body: - type: checkboxes attributes: label: Can I help implement this? πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’» - description: The maintainer will provide guidance and help. The implementer will read the PR guidelines https://github.com/jokob-sk/NetAlertX/tree/main/docs#-pull-requests-prs + description: The maintainer will provide guidance and help. The implementer will read the PR guidelines https://jokob-sk.github.io/NetAlertX/DEV_ENV_SETUP/ options: - label: "Yes" - label: "No" diff --git a/.github/ISSUE_TEMPLATE/i-have-an-issue.yml b/.github/ISSUE_TEMPLATE/i-have-an-issue.yml index ea5eea27..3d1d488c 100755 --- a/.github/ISSUE_TEMPLATE/i-have-an-issue.yml +++ b/.github/ISSUE_TEMPLATE/i-have-an-issue.yml @@ -7,7 +7,7 @@ body: label: Is there an existing issue for this? description: Please search to see if an open or closed issue already exists for the bug you encountered. options: - - label: I have searched the existing open and closed issues and I checked the docs https://github.com/jokob-sk/NetAlertX/tree/main/docs + - label: I have searched the existing open and closed issues and I checked the docs https://jokob-sk.github.io/NetAlertX/ required: true - type: checkboxes attributes: diff --git a/README.md b/README.md index a1693d17..ee33abd3 100755 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Get visibility of what's going on on your WIFI/LAN network and enable presence detection of important devices. 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 guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) | [πŸš€ Releases](https://github.com/jokob-sk/NetAlertX/releases) | [πŸ“š Docs](https://github.com/jokob-sk/NetAlertX/tree/main/docs) | [πŸ”Œ Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md) | [πŸ€– Ask AI](https://gurubase.io/g/netalertx) +| [πŸ“‘ Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) | [πŸš€ Releases](https://github.com/jokob-sk/NetAlertX/releases) | [πŸ“š Docs](https://jokob-sk.github.io/NetAlertX/) | [πŸ”Œ Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md) | [πŸ€– Ask AI](https://gurubase.io/g/netalertx) |----------------------| ----------------------| ----------------------| ----------------------| ----------------------| ![showcase][showcase] diff --git a/dockerfiles/README.md b/dockerfiles/README.md index 0129c332..48fba4a2 100755 --- a/dockerfiles/README.md +++ b/dockerfiles/README.md @@ -6,7 +6,7 @@ # NetAlertX - Network scanner & notification framework -| [πŸ“‘ Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) | [πŸš€ Releases](https://github.com/jokob-sk/NetAlertX/releases) | [πŸ“š Docs](https://github.com/jokob-sk/NetAlertX/tree/main/docs) | [πŸ”Œ Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md) | [πŸ€– Ask AI](https://gurubase.io/g/netalertx) +| [πŸ“‘ Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) | [πŸš€ Releases](https://github.com/jokob-sk/NetAlertX/releases) | [πŸ“š Docs](https://jokob-sk.github.io/NetAlertX/) | [πŸ”Œ Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md) | [πŸ€– Ask AI](https://gurubase.io/g/netalertx) |----------------------| ----------------------| ----------------------| ----------------------| ----------------------| diff --git a/docs/DEV_ENV_SETUP.md b/docs/DEV_ENV_SETUP.md index b7689ecc..dd552fce 100755 --- a/docs/DEV_ENV_SETUP.md +++ b/docs/DEV_ENV_SETUP.md @@ -97,18 +97,18 @@ Most code changes can be tetsed without rebuilding the container. When working o βœ” New features are **reusable**, not narrowly scoped. βœ” Features are implemented via **plugins** if possible. -### βœ… Suggested Test Cases +### Mandatory Test Cases - Fresh install (no DB/config). - Existing DB/config compatibility. - Notification testing: - - Email - - Apprise (e.g., Telegram) - - Webhook (e.g., Discord) - - MQTT (e.g., Home Assistant) + - Email + - Apprise (e.g., Telegram) + - Webhook (e.g., Discord) + - MQTT (e.g., Home Assistant) -- Settings persistence. +- Updating Settings and their persistence. - Updating a Device - Plugin functionality. - Error log inspection. diff --git a/docs/FRONTEND_DEVELOPMENT.md b/docs/FRONTEND_DEVELOPMENT.md index 16dee2eb..d761bf84 100755 --- a/docs/FRONTEND_DEVELOPMENT.md +++ b/docs/FRONTEND_DEVELOPMENT.md @@ -1,4 +1,4 @@ -# πŸ–Ό Frontend development +# Frontend development This page contains tips for frontend development when extending NetAlertX. Guiding principles are: diff --git a/docs/INITIAL_SETUP.md b/docs/INITIAL_SETUP.md index 320752e3..8ede12eb 100755 --- a/docs/INITIAL_SETUP.md +++ b/docs/INITIAL_SETUP.md @@ -36,5 +36,7 @@ ## πŸ› οΈ Common Issues Before creating a new issue: + - Check if a similar issue was [already resolved](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed). - Review [common debugging tips](./DEBUG_TIPS.md). +- Check [Common Issues](./COMMON_ISSUES.md) diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 04143bd0..92bd6a44 100755 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -1,4 +1,6 @@ -# Installation options +# Installation + +## Installation options NetAlertX can be installed several ways. The best supported option is Docker, followed by a supervised the Home Assistant instance, as an Unraid app and lastly on bare metal. @@ -7,6 +9,9 @@ NetAlertX can be installed several ways. The best supported option is Docker, fo - [[Installation] Unraid App](https://unraid.net/community/apps) - [[Installation] Bare metal (experimental - looking for maintainers)](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) + +## Help + If facing issues, please spend a few minutes seraching. - Check [common issues](./COMMON_ISSUES.md) @@ -15,4 +20,6 @@ If facing issues, please spend a few minutes seraching. - Check [Discord](https://discord.gg/NczTUTWyRr) > [!NOTE] -> If you can't find a solution anywhere, ask in Discord if you think it's a quick question, otherwise open a new [issue](https://github.com/jokob-sk/NetAlertX/issues/new?template=setup-help.yml). Please fill in as much as possible to speed up the help process. \ No newline at end of file +> If you can't find a solution anywhere, ask in Discord if you think it's a quick question, otherwise open a new [issue](https://github.com/jokob-sk/NetAlertX/issues/new?template=setup-help.yml). Please fill in as much as possible to speed up the help process. +> + diff --git a/docs/PLUGINS_DEV.md b/docs/PLUGINS_DEV.md index ed783860..696fb748 100755 --- a/docs/PLUGINS_DEV.md +++ b/docs/PLUGINS_DEV.md @@ -776,8 +776,8 @@ The UI will adjust how columns are displayed in the UI based on the resolvers de } ``` -[screen1]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main./img/plugins.png "Screen 1" -[screen2]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main./img/plugins_settings.png "Screen 2" -[screen3]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main./img/plugins_json_settings.png "Screen 3" -[screen4]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main./img/plugins_json_ui.png "Screen 4" -[screen5]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main./img/plugins_device_details.png "Screen 5" +[screen1]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins.png "Screen 1" +[screen2]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins_settings.png "Screen 2" +[screen3]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins_json_settings.png "Screen 3" +[screen4]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins_json_ui.png "Screen 4" +[screen5]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins_device_details.png "Screen 5" diff --git a/docs/SETTINGS_SYSTEM.md b/docs/SETTINGS_SYSTEM.md index 5c4362b0..eb04b857 100755 --- a/docs/SETTINGS_SYSTEM.md +++ b/docs/SETTINGS_SYSTEM.md @@ -74,4 +74,4 @@ Here's a high-level description of the code: _____________________ -[screen1]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main./img/plugins_json_settings.png "Screen 1" \ No newline at end of file +[screen1]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins_json_settings.png "Screen 1" \ No newline at end of file diff --git a/docs/img/NetAlertX_logo.png b/docs/img/NetAlertX_logo.png new file mode 100755 index 0000000000000000000000000000000000000000..f2b8e23b4d9fa7aa714d1504a04cce20a0119ea0 GIT binary patch literal 6753 zcmW-mbzD>58^`ZPOLvVPh|;AuW?)h0Du~)t7!&aKm7ZUlY-y1_v@a6 z7YdZFl|KN`^!@ul27M|Xf)CjPwC)Go^>GOZcJOlsf`fy_-Mu~iog7fk;y!+^`MXLS zpv^8)Q_Vc2;AdgDiMi$T!EQWfyL*Y62~(C@Dw<;)nI_d$I)P2>H?c4<5X$fsN^)tc z{OA?r5-ek_xc#g~F5du`_tphxC4;;r<2$I6nlXZ&IOElW+1*UOMW@DlGgb-8FKf8G zd^HiEnNXhJb$aC;Tx2|rZ+@{BHKyF{Q*@!E6N`|-egIa4fV&U_Xy!G0GanzHWH>TO zyG-gq<)fj-1vg2yPmnWG1T*^e#Z^rvywa}nXS@OfJ_hkpg6b}01cIvWBRq4EWRp(S zE=!o>z*gMDy(k0HA;Kj4FX70*krpTeJ)OiRWj`(O@D40p6p3@eBqV70T^zDlWp_)l zQIP==bJz3X$o_4;zgTn#8mmooe`b0*uxP@~#!EW4v{m^A3B4^2zUdFlL%!?b0&?dc zbJIiGX!!MT&c88STwEENIy%w+;owC0>u<80+Xn3=cVa|D6$OzV-%nn!Y9atSQy7}; z>-_xe{n{CJ96VtsijUt4_aXw=Bl>a^X~v4bZlvBq2cWSoHthkM>rzruwDA}W#{Xi1 zvr#mdjVkdk(LNaxr`PreMdt_ME6q|?R{m>`pD${9P)o581tqb{)~6!v;{h&_xEJ2u zst@R;K`Z3w=;)Z1wsu`Q7K>duVXXMj7%^loc}dgbBZxfDp3nG79ErdRm$kKpMtXVe z_{F`W`}K4B+N;Sq7g>&FV80xW6kCXz;&-D=#Foq5y4A(a!xQaFUgTe$KDoIg%aP^- z4Y|Xn^Q5>M#?N7EX?YrEX7*XYv41>$X=%x)ueUdfWaSYOSFjNEgx~EN7R&G9>G{`l z?6!&g_`RC7{7_4ya{1}S7^<(3lS5i>NpQFvmSFWgV`jCu8 zZ@gmRry?+9SI_5DB#5WTaXC4sM-5JcGs!4oZkMJxCC7g3vfS<4Jn+(ng{ZfJyxN)P z=V8OSGOmZat>4l~7VLS}!{oTO55AR_6mcS?qtlT zARG-tt~JQ(XwGq`c*`^fskKgZNw{+xcsozpHp~WTTp zgvoD~8XZ_bQX}*?wK@$BJju(`TaGxQ4(1^b(6hDWGR%`rs(Z}|j5XbB(5rc$_Rl0c zTS%S1HKx5?LC?^TtKJ1nqTI8ks5kPPZInH(0BNB+Tv?gx;&e~P(Xo^?=*->IQ$t^$ zQbAF1VtP8^Z^=9fGAPD zj-iAH8Jwtx4-mkduY4bR+z|aYDwXrLk+c5R@pUJv2^!CO&l?zDp5z4uGA^>NP-=;FW zNx&5i@6h~TN#~DDJM(ynV)fMk1=9x)l6!mAnOIm#D=NsDnVB=4e+nH)<{CUxiB$M8 zk{dVI#X=UK;#E;SZ%9k$_!gHvTFpPda=0MMPp9zm4#r-n> zS4M?;)YQ}qkwMfs;+5Xk{L$vH zV-GM@};=np6_4kK}5A8Ko*Pd(rz9ekm;FeJXpOT}^>B8&$L4 znw~=Bd9%kwp6)cN^<~FVRtKTIqw+x+tLS}1VPRo%@JzX3{$*Pj!;@>2lx5e8B5+&V z+sw<$Z{EC-^KlrR`JHUXqA3IF5?yEf zfx*Edjbmfam8-Sn7d!yTYYHn)ZeQH>bHtBD;53-HrI2sb$;ru%54AF z^c2NkDdVc#29lY-qe4^@W^{NW;o8(BvJSn(3aAzI>_umJx%O~hRZIX2F#P!W>kBt? zU**FO0vby@9`5cX7kk}Bo%OLu?XoN|W$75bn*7%Fx~i)5#S3^)H((d@-hgDh4DH)} zeD*Da_N%F&pkRSU__)aR>#pPB=1-qKm5sU#3Cf7vf=IG+;HuRH5^G(bhyF;UIS1{B z92@GxDTBb3dp9)nx7@{&OH!d&(cpIzKgJVPjH_w*WWtfZW~_ZCKEKqT>x?h$?d^5@`Ss0{%*>wMfjFagefhO| z_1a`4Z1S}G;J9cFMuWK znMHNFiqjD*90Q+$FPQUUyugQVbObtL+GV2pkNLD=GO=tc3a7e9gIS1TnVY}@)oj^8 z-0CQKBa9ywyW%8m!#Eb&pO3y=h?aoHh_g4gU=;e>nGspicEnIyX(Gg?y(-LuI8@IH z{CW5Ow@u7*?Mz`{9nci<(BU0t)HZ?T_Y?_S}sq#=zQ1o5df-79!?>l+d*(#;iau?St<06Z3 zcikgqbX(UYW@sh4LeyR^?3Y{E$((CtaWVR#)ydgRp{lvL`MADBr{-k2p_7k4oiMXX zy#-k!kr9{(n;rT{2g-#G6L2_&^G)MuJprBchs(5(s%Q*t!Bh+Z4NhOP*PQg%CfAIr zvIIO>?k1~WcU9#Czav5pt_bETNOIEUDTm);W@19QIwE$06gyA8dOB(z7~Un2YzNqz z&*~wOCEb^6676hKiKPt6Z(ypZXOzoel3Ub__Voj^FH| z>nB2O^;GPF1x8y-OKTx;msLzm?AN#kZNr{ES2e4~$a?jMEt7ZU36!j6o}MDXks|NU zkGJPeE7OlPetkQ4Z7?rl5v02zA)yl)sf?%Aa`W=)f1k$L_GlwlO@Q zU~XaY{?FPTE31Uvi_}!AlgLW{!a-ha$GV1ariS0as@BJmk%!9|NNK(#V7$@uY?qmb z$9OP}4%}i37H>;SN+4jWy#8@`xUH6$ zfym_@>D71AR7WSL%GTCr;i!FGaA+^f%NzHqfhnYoj;y&|ybK#NCujA1xIkcFAU~`x zhjCV{UB;NK9BLLug?#j=_I}%J^eAcF^Ed;H{r%>a7RSxcFNMX$f3!e>irU(NQmqu! zj}dlnk(f`iD;|h)DGrK|2iDdN4~G~|GF$shZEZ)l1aw=47%@GnFG${Mr^Ap52??T@ zdvbDePjI;2F4|aKvhfTdF1BmeeB)n~mZ}?XLr7D^i!*e&o>AN!7#J``B9nv&@{#AV zX`HvyJ4e-o*?Y(lZ`CT2o7s>7UEKDPZa0f3weG~Jc_eD4!tyq}iO@{s<|VbY)N^xl z!eU$jTeA+P78Z#llq@T~36vVq_g82csp%-cRp^0Wz#?InTFUSI15gdxVf%LjMpP@R zs7D|PsE1r?SdHr^_0@joRZ??qk(m&1io+g z=zegM=erYeCaI;P(-cmt_LB_l2b$ja&4AOu&}2<}IG@5wZxW#uz=wB28F81F5%e^6 zg(Ur&)Lw^7xHvLeGjnsMjzPNFP{3_ECM$Cq!8g|#e%nfvCCEqJjTCJJzUY2Ti}dyu z*V5Fi4`+au_*mV-(4@w{U0q$>cxq|K*EBb>tF@tc%(k-lU=#W@35!KoSg>fP9m>nq zAgoh?agwVSiOmcQ3>))4-GcnHPrgoAXNTR?GMpMsX8XJy6QePzTaB;?XlWL<0VBqztI zH=cq+k?~ibH)7d08=(j;K+}8o5?Wj3Gm27@lY56AU)Rz-+mJ5abHO4w-%?}pD=LKl zy|>z*bW@R$sz;EXj@lQ~H>=;4m6av$yGrcc?%redn`CRk3qU2!YYEeFa;AXr<*>Yt zO-=0w+sk_Xyslm*hOD2wlmygV6*V>e8xv)J&XrkGNI>-H1M!X7Plzqng$S+f&H65N z+T$J^<}J!Xna-`8eB*Ap@Zkk9x4Se@u@*#MbHCOi;?MCcn~Y0pY4@ySLveGndAw%i zCk|i=)j_UZVZIg*fx_fRXaBJ!w21LRI4urE+7!+e4+M%0zs@v&(F_~+M2onGHLpv4iZTL z>L{y7Vv1Sf7pW7v2u6B(Nd9PfzRu*Riww9>r5@$ozc*%FH>4?jW}FN)qNk@1IN7l> zH2%=}vZEuv+_>mdR|fR{ZG$cGY=0A>N6STEY=hJyT zUOuQa3?x6J=Su7-35i?-A(%=8n~dwH?=1|%5jiB4%c^;VJVJj>TOrW%P`c#pTUcdf z<$^_GS|6e3ZRin`_0OBSn@~xHNPoFsJZd{YI!gYt;%=5eW*-CqY19$Uo(KJv|Ka<& z74uQ^acT6wz6#`HKm_*|NnW8DslSA)S9Nk9p%^6T#ywB2O72Zilo4Hw7-9Z0t=Og-7`(gKEjMshO&@)Y3EV`t>|56db{v=u>rc}X6*9V}Uqld?x!7pGqH1hAW<)YnuMRS- z)IZP9>!+}YIqnIh{qm%W3ji8vMygrT!JIcrnc=pP^)1Xd4c^(=*&K4)EN5KutPdMAEel05@%D>i2$R9i8sPGuib%}(7jui!Rb-)CxKQXI-hU&%^?Z~Z5# z;`rd*39$yym2tJQ2pq_WYdQaU*da8Rme=-{?c3rfD%|BefDpoAX;Q5(;@aT5 zI5Ig282_b81oo`&pFcXbiJn?=_d-p{sJSFz z7bia_-%4V!b`b|!Cnu+@uDZM3f1^%L!pEa&OvaL(VmzH~cHjTM(NYCKfV9H(UWj=d zX%g6ra3vX8&BLdeD|s>L%CP?;4ibKlAYS}MwF;_3p_v(;ujZ!XH&KQYA6U{m!%sby z4m4x_AG=0S-|U{uL+Wdhr=Aj2$*2v44PTaXt|DB5>Om(5I6)r3-Ks<IsUgArwx{({KTG1b2|M>Im$F8?0|GM)&N;T8qR!fuIor+Ou0&Mf5e zv3j>B0*>qjiR&L7$laFV1qD|{Rn_N+4v(yYg4DCKkWsw8X2=-<)8IZSBzEicCOUfB zQDX@l0oBbYft@c68b?0LF^3--4Kh^DE54QuQf#b@Z-q%0e|8d{$NQ}BTE@gyz;NO~ zyDj|63X39ti^z5k+i4h_BL6U1bq^2K1#YR8ypKBHe6{dL*o2;0z0q`Z)goCKxK40& z!atgSzZear&UDUw9alYlz{RYQ`uyo>fEgby&_wU6m zEi7O`I$G<#qUzDPIrljpzcO(99jK$)y8DS0zyUvKa!JFNVT@CjHkbv_KljJS#jIOU zrzr>>&~ans<0%uu8Pygy#9faGE%0w(Lv(z1Qh|2IH8Ck5dE#{mDD!{plEtL6!{LKK zf8)J|kNrf#WQhD*k5-rd#sdFh0!CnwP!C}ne(;VX^XwfNPqXh{h}sJ8u(a~ghzvE# zQ1Rsr(%RePvw2i=pa9QeZxJI$fU-f%s_`MS&6~0tdEFm&fArC+j)2|`_*PGI$XfCf zf1F%g6x&B4KEE%M@|96V`J1+nw0Y`~G8kA9(NZ8)c}Bj{(I?{efR zvu~)q*vP`dLJMd`{cSKKT0uzYegCFbu>=PvXUE~u(OsU9l^8uEo}J}|(9qCAu)4n< zc>n%Nn2*l^j^}}>f+Wdm{onzPMcgJNX`XWa&IiQKVn^`b)qxaNzYDs3Q#-pTB>{nN zWZ=2)DnHHOy&AQlj~^d2gUShCXmlOV9P^%z9_;7uZ5f#(md<#h@j3EUm%c>mQza1p z6(c))r@wwpo|&&?VwoGwSJcD1*k zh zGQMuBu49)&8r~>+*TI3H#_!l|!nE(T(0V{fPfv%Oo`L6bUntc#w8b7YV_`IdXu`(U zmf!AD=LIsOP<%h__Hu;GSC^*gljRA;;N6E3#3k?Ke3q29HaFXZVBkRnE9l{yq8Tak zFQ6QZw&{wP1E(ek2T$rGk5}4mnfET+-Sys5q>m2Wf6grYzCCbT8$7K3j~9{slE(LV zA!z>5-sSP@=zEa|2Jg}gAoaADTD-FLCs19U=2POlETR?9eb)F){d<5#*p5`pk7tle zC_?d!5^jDhW}{E@46`8u5hw#{;>eS;w}|&i)mH+)*zbLf6P;0CJ`=gWLHefmc&+TW;wtnQ8|#_d+O#53kC+Z^rTK3lTv5${4b2SrNu>_G z(J<)*u4eFKy@?IoBoG5>n`La^iiBq8rYQP9$k~$QX)P~SvgggieNGgYHj4FnPTor1 z4P{D&@LZ!}o>YLPS572Scp;*Ocwfk7dojht1|z;KJjLz~G+s0Vb&vlb%83vvHtY7G zz^DDM6Sw(!yBy-Tf4>ezap4we?D?z9O4@*8;vT+M7cB|m@xCo#G#%uiND5UutlYUb z=8me(d3F49{8lRs#V}B?ahKg@ojKNlA6m*SK;W=70}RmH-bZe&+zGzJRI`nAqyV8c z>@0{KO@yYJJu(aeM*jp*)Mb^hAgFCD3%;8Bn35m<4PazuvY$Vl1OFZZkXlBXb?Wx9 F{{xb4rd9v| literal 0 HcmV?d00001 diff --git a/docs/index.md b/docs/index.md index b6cd9dea..416cebb9 100755 --- a/docs/index.md +++ b/docs/index.md @@ -1,31 +1,80 @@ -# NetAlertX documentation +# NetAlertX Documentation -## ℹ️ In-App Help +Welcome to the official NetAlertX documentation! NetAlertX is a powerful tool designed to simplify the management and monitoring of your network. Below, you will find guides and resources to help you set up, configure, and troubleshoot your NetAlertX instance. -- Hover over settings, fields, or labels. -- Click the blue ❔ (question-mark) icons. -- Access the in-app **Help / FAQ** section for frequently asked questions. +## In-App Help + +NetAlertX provides contextual help within the application: + +- **Hover over settings, fields, or labels** to see additional tooltips and guidance. +- **Click the blue ❔ (question-mark) icons** next to various elements to view detailed information. +- Access the in-app **Help / FAQ** section for frequently asked questions and quick answers. --- -## Installation +## Installation Guides ### Docker (Fully Supported) -- [Follow the official installation guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md). +NetAlertX is fully supported in Docker environments, allowing for easy setup and configuration. Follow the official guide to get started: -### Bare-Metal +- [Docker Installation Guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) -- πŸ§ͺ [(Experimental) On-hardware installation](./HW_INSTALL.md) (looking for maintainers) +This guide will take you through the process of setting up NetAlertX using Docker Compose or standalone Docker commands. + +### Bare-Metal Installation (Experimental) + +If you prefer to run NetAlertX on your own hardware, you can try the experimental bare-metal installation. Please note that this method is still under development, and we're looking for maintainers to help improve it. + +- [Bare-Metal Installation Guide](./HW_INSTALL.md) --- ## Help and Support -Before opening an issue: +If you need help or run into issues, here are some resources to guide you: -- πŸ” [Check common issues](./DEBUG_TIPS.md#common-issues). -- πŸ“Œ [Look at closed issues](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed). -- ⚠ **Enable debugging** before reporting: [Debug Guide](./DEBUG_TIPS.md). +**Before opening an issue, please:** -❗ **Follow the issue template** for faster resolution. + - [Check common issues](./DEBUG_TIPS.md#common-issues) to see if your problem has already been reported. + - [Look at closed issues](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed) for possible solutions to past problems. + - **Enable debugging** to gather more information: [Debug Guide](./DEBUG_TIPS.md). + +**Need more help?** Join the community discussions or submit a support request: + + - Visit the [GitHub Discussions](https://github.com/jokob-sk/NetAlertX/discussions) for community support. + - If you are experiencing issues that require immediate attention, consider opening an issue on our [GitHub Issues page](https://github.com/jokob-sk/NetAlertX/issues). + +--- + +## Contributing + +NetAlertX is open-source and welcomes contributions from the community! If you'd like to help improve the software, please follow the guidelines below: + +- **Fork the repository** and make your changes. +- **Submit a pull request** with a detailed description of what you’ve changed and why. + +For more information on contributing, check out our [Dev Guide](./DEV_ENV_SETUP.md). + +--- + +## Stay Updated + +To keep up with the latest changes and updates to NetAlertX, please refer to the following resources: + +- [Releases](https://github.com/jokob-sk/NetAlertX/releases) + +Make sure to follow the project on GitHub to get notifications for new releases and important updates. + +--- + +## Additional Resources + +- **Configuration Tips**: Learn how to optimize NetAlertX for your network setup. +- **Advanced Features**: Explore advanced functionalities like plugin development and custom configurations. +- **Documentation Index**: Check out the full [documentation index](https://github.com/jokob-sk/NetAlertX/tree/main/docs) for all the guides available. + +We hope you find this documentation helpful. If you have any suggestions or improvements, please don’t hesitate to contribute! + +--- +NetAlertX is actively maintained. You can find the source code, report bugs, or request new features on our [GitHub page](https://github.com/jokob-sk/NetAlertX). diff --git a/front/php/templates/footer.php b/front/php/templates/footer.php index 62625f12..a6402881 100755 --- a/front/php/templates/footer.php +++ b/front/php/templates/footer.php @@ -29,7 +29,7 @@
| - | + | | | | : diff --git a/mkdocs.yml b/mkdocs.yml index 6a3082dd..df47f00c 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,11 +2,14 @@ site_name: NetAlertX Docs site_url: https://jokob-sk.github.io/NetAlertX/ repo_url: https://github.com/jokob-sk/NetAlertX/ edit_uri: blob/main/docs/ -static_dir: docs/img +docs_dir: docs +# static_dir: docs/img nav: - Home: index.md + - Installation: - Installation options: INSTALLATION.md + - Quick setup: INITIAL_SETUP.md - Docker Guide: https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md - Docker Compose: DOCKER_COMPOSE.md - Docker File Permissions: FILE_PERMISSIONS.md @@ -15,8 +18,10 @@ nav: - Bare-metal (Experimental): HW_INSTALL.md - Migration Guide: MIGRATION.md - Common issues: COMMON_ISSUES.md + - Docker Updates: UPDATES.md - Setup: - Subnets: SUBNETS.md + - Enable Plugins: https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md - Common issues: COMMON_ISSUES.md - Remote Networks: REMOTE_NETWORKS.md - Notifications Guide: NOTIFICATIONS.md @@ -51,12 +56,15 @@ nav: - API: API.md - Database: DATABASE.md - Settings: SETTINGS_SYSTEM.md - - Updates: UPDATES.md - Versions: VERSIONS.md theme: name: material + logo: img/NetAlertX_logo.png # Reference the favicon here + favicon: img/NetAlertX_logo.png + extra: + home_hide_sidebar: true features: - announce.dismiss - content.action.edit @@ -103,7 +111,5 @@ markdown_extensions: plugins: - gh-admonitions - search -font: - text: Roboto - code: Roboto Mono - favicon: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/front/img/NetAlertX_logo.png + +favicon: /img/NetAlertX_logo.png