From fda04b9576bcfac6adbb91eef85f6ca41cae30a0 Mon Sep 17 00:00:00 2001
From: 0xJacky <me@jackyu.cn>
Date: Mon, 1 May 2023 01:08:05 +0800
Subject: [PATCH] docs(wip): added docs of config

---
 frontend/docs/.vitepress/config.ts      |  13 +++-
 frontend/docs/guide/about.md            |   2 +-
 frontend/docs/guide/config-nginx-log.md |  18 ++++++
 frontend/docs/guide/config-openai.md    |  32 ++++++++++
 frontend/docs/guide/config-server.md    |  79 ++++++++++++++++++++++++
 frontend/docs/public/favicon.ico        | Bin 0 -> 67646 bytes
 frontend/docs/reference/api-examples.md |  49 ---------------
 7 files changed, 142 insertions(+), 51 deletions(-)
 create mode 100644 frontend/docs/guide/config-nginx-log.md
 create mode 100644 frontend/docs/guide/config-openai.md
 create mode 100644 frontend/docs/guide/config-server.md
 create mode 100644 frontend/docs/public/favicon.ico
 delete mode 100644 frontend/docs/reference/api-examples.md

diff --git a/frontend/docs/.vitepress/config.ts b/frontend/docs/.vitepress/config.ts
index aa326fe0..63b1fefd 100644
--- a/frontend/docs/.vitepress/config.ts
+++ b/frontend/docs/.vitepress/config.ts
@@ -15,7 +15,6 @@ export default defineConfig({
         nav: [
             {text: 'Home', link: '/'},
             {text: 'Guide', link: '/guide/about'},
-            {text: 'Reference', link: '/reference/api-examples'},
             {text: 'Demo', link: 'https://nginxui.jackyu.cn'}
         ],
 
@@ -30,10 +29,22 @@ export default defineConfig({
                         {text: 'Contributing', link: '/guide/contributing'},
                         {text: 'License', link: '/guide/license'}
                     ]
+                },
+                {
+                    text: 'Configuration',
+                    items: [
+                        {text: 'Server', link: '/guide/config-server'},
+                        {text: 'Nginx Log', link: '/guide/config-nginx-log'},
+                        {text: 'Open AI', link: '/guide/config-openai'}
+                    ]
                 }
             ]
         },
 
+        search: {
+            provider: 'local'
+        },
+
         footer: {
             message: 'Released under the AGPL-3.0 License.',
             copyright: 'Copyright © 2021-' + thisYear() + ' Nginx UI Team'
diff --git a/frontend/docs/guide/about.md b/frontend/docs/guide/about.md
index 9913e2b0..922f5c25 100644
--- a/frontend/docs/guide/about.md
+++ b/frontend/docs/guide/about.md
@@ -1,6 +1,6 @@
 # What is Nginx UI?
 
-![Dashboard](../public/dashboard_en.png)
+![Dashboard](/dashboard_en.png)
 
 Nginx UI is a comprehensive web-based interface designed to simplify the management and configuration of Nginx servers.
 It offers real-time server statistics, AI-powered ChatGPT assistance, one-click deployment, automatic renewal of Let's
diff --git a/frontend/docs/guide/config-nginx-log.md b/frontend/docs/guide/config-nginx-log.md
new file mode 100644
index 00000000..8904e513
--- /dev/null
+++ b/frontend/docs/guide/config-nginx-log.md
@@ -0,0 +1,18 @@
+# Nginx Log
+
+Nginx logs are essential for monitoring, troubleshooting, and maintaining your web server. They provide valuable
+insights into server performance, user behavior, and potential issues. In this section, we will discuss the two primary
+types of logs: access logs and error logs.
+
+## AccessLogPath
+
+- Type: `string`
+
+This option is used to set the path of nginx access log for Nginx UI, so we can view the log content online.
+
+## ErrorLogPath
+
+- Type: `string`
+
+This option is used to set the path of nginx error log for Nginx UI, so we can view the log content online.
+
diff --git a/frontend/docs/guide/config-openai.md b/frontend/docs/guide/config-openai.md
new file mode 100644
index 00000000..5b8364e8
--- /dev/null
+++ b/frontend/docs/guide/config-openai.md
@@ -0,0 +1,32 @@
+# Open AI
+
+This section is for setting up ChatGPT configurations. Please be aware that we do not check the accuracy of the
+information you provide. If the configuration is incorrect, it might cause API request failures, making the ChatGPT
+assistant unusable.
+
+## BaseUrl
+
+- Type: `string`
+
+This option is used to set the base url of the api of Open AI, leave it blank if you do not need to change the url.
+
+## Token
+
+- Type: `string`
+
+This option is used to set the token of the api of Open AI.
+
+## Proxy
+
+- Type: `string`
+
+This option is used to configure the proxy for OpenAI's API. If you are unable to access OpenAI's API in your country or
+region, you can use an HTTP proxy and set this option to the corresponding URL.
+
+## Model
+
+- Type: `string`
+- Default: `gpt-3.5-turbo`
+
+This option is used to set the ChatGPT model. If your account has the privilege to access the gpt-4 model, you can
+configure this option accordingly.
diff --git a/frontend/docs/guide/config-server.md b/frontend/docs/guide/config-server.md
new file mode 100644
index 00000000..701402bc
--- /dev/null
+++ b/frontend/docs/guide/config-server.md
@@ -0,0 +1,79 @@
+# Server
+
+The server section of the Nginx UI configuration deals with various settings that control the behavior and operation of
+the Nginx UI server. In this section, we will discuss the available options, their default values, and their purpose.
+
+## HttpPort
+
+- Type: `int`
+- Default: `9000`
+
+Nginx UI server listen port. This option is used to configure the port on which the Nginx UI server listens for incoming
+HTTP requests. Changing the default port can be useful for avoiding port conflicts or enhancing security.
+
+## RunMode
+
+- Type: `string`
+- Supported value: `release`, `debug`
+
+::: tip
+At present, we have not yet adapted to this option, and there will be no significant differences between release and
+debug in terms of usage.
+:::
+
+## HTTPChallengePort
+
+- Type: `int`
+- Default: `9180`
+
+This option is used to set the port for backend listening in the HTTP01 challenge mode when obtaining Let's Encrypt
+certificates. The HTTP01 challenge is a domain validation method used by Let's Encrypt to verify that you control the
+domain for which you're requesting a certificate.
+
+## Database
+
+- Type: `string`
+- Default: `database`
+
+This option is used to set the name of the sqlite database used by Nginx UI to store its data.
+
+## StartCmd
+
+- Type: `string`
+- Default: `login`
+
+This option is used to set the start command of the web terminal.
+
+::: warning
+For security reason, we use `login` as the start command, so you have to log in via the default authentication method of
+the Linux. If you don't want to enter your username and password for verification every time you access the web
+terminal, please set it to `bash` or `zsh` (if installed).
+:::
+
+## PageSize
+
+- Type: `int`
+- Default: 10
+
+This option is used to set the page size of list pagination in the Nginx UI. Adjusting the page size can help in
+managing large amounts of data more effectively.
+
+## CADir
+
+- Type: `string`
+
+When applying for a Let's Encrypt certificate, we use the default CA address of Let's Encrypt. If you need to debug or
+obtain certificates from other providers, you can set CADir to their address.
+
+::: tip
+Please note that the address provided by
+CADir needs to comply with the `RFC 8555` standard.
+:::
+
+## GithubProxy
+
+- Type: `string`
+- Suggestion: `https://ghproxy.com/`
+
+For users in mainland China who may experience difficulties downloading resources from Github, this option allows them
+to set a proxy for github.com to improve accessibility.
diff --git a/frontend/docs/public/favicon.ico b/frontend/docs/public/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..6c40bc91735edc02e7d3c6b71f34845ce0e5db42
GIT binary patch
literal 67646
zcmeHQSxj74nl6*bi6Soqn+pbGc8ra=wlQ0xsMBh-qV85dj52DeA6l)}s2@gAYaaSx
zG@6%Sz`GqUDciJ-W4z!69D+AocD$uC9gRj&W)zL4fhwR3n9WeY#U>T2lr!Id?!8rY
z3#f&HIO_h1PO8p5_fmg--@l(jVzVv5KUGyW{5#85`05gyVzb!_F>r}4%Iox&e;5Hq
zfDvE>7y(9r5nu!u0Y-okU<4QeMt~7u1Q-EEfDvE>7y(9r5nu!u0Y-okU<4QeMt~7u
z1Q-EEfDvE>7y(9r5nu!u0Y-okU<4QeMt~7u1Q-EEfDvE>7y(9r5nu!u0Y-okU<4Qe
zMt~7u1Q-EEfDwomfzIs}i5=CIwHS_$?d6X4;89(1<=YGY_;R$rYccL?uc=(xUS0Xm
zkgLs<t)sdEvSL8y&g#ndx~kuJbum8s@8Nd>L!}*9wpW#lzhdA$hW`53?d2Zlk)OXX
z{<~@_5+KhzkfU45B;_O7Oj*kX^uX?{e)F}z2d)<5J9gGoDr8SO_rd&2oL?yauG%+N
zfdBi!d|TxtU1k2`(F?!*OPkkiOSk_Q%fE9+<*U%k-9fVW{Sx`Az;)(79{$_68~*<X
z#DCA}AKTh%Dt-Zu2Le0?a~|;jZ2$4FZ?l>He-4~qi2sM(7a$k?qP@D@H-}t)`{(!{
zKmYBB|8wB{z4PC-`=>8=RF~JyA&;MTbDjB*kN*zje?JudJ8LTvz~{T*)&tw0!L`YG
z@GJBGx50nU-ZEQ9ZFvc7|9|}4N1+2c|8H>pH%~SAq1b;%ZN<`#n)35{%rA?|_Q?<E
z{8uvn^W=YK{s-&>cK5x+e`n2`6!ZV7eS6t+4E^&-1}TTs1+V|QxlZ*8*4h8hlX&AX
zoqyT)ooRE`i{JkfO~0~r)|Qud)Rwh()DZW^FnO*ne+s|Q0$ZOB(o4Urs1>;X7l#UT
z)>NSXXYwy?O~+QZy+yZw*PhbVojXe}b?zvA-nnC&=%_6f9W|v=4?3#Ld>u6vEs*gY
zaIcXMfUE((!1f;p^ZKI}|1UYGyqj#0a4uU^{>71>C%E>O{F`%kiO;#KM9}EmxlJFW
z2eqZH&g!zl&K;F1c-M59NWOp$Nc-Qx{r~wYf}ejs_a^_awVK7{zh_@brEBk&UJT*f
zvsJh-pbJtDoIAHoW4uS-%eA9Sg)HFT&`VQ4DgUc3hySnO{BNEL&{<P%_<!>Kgs<dX
z`eFEEPv0W!|BW4~u(?0jlGS}+^PTSfn?)CmeOrWU?`90V?%DF(wY#LQYfovS<bQXm
z3RyHgHt6!1u|V=)!~D;ae)NBh_)ol>-0vtA6pP`HJ@C;BzW?h!tS0mvQg?TMQ0&DJ
zavV@a_kLB^h5cK;>fT#I|9chr;{yMXMU%0i7V&{%gY*R?GwgpS`+pOwSYOTjpK@=q
zFXFv(r{RNlZC!Bwhfi*@_1cTx>N#Ab^&HwH{NrG;=#jdhPQx#}JGAee1oOMN_LZoJ
z4VrTo;sfOfB%_fhLT<a0?cand=2z5SN@s1ELvoMYi|}>r)?=}2@51xndvs%7uYKbe
z?hiK#_lHHoeZ&}ti%1u|?n9gQKRQ%wInU!huvK;K+pOvNfuRG?QPKg_4Y2=mj{h+;
zuRq}2S*8F(2l-aw-U;rz5QDoAi@Wx1UQqk*J67~s@3D=09~~|9_8#3J9?`I4Ko=fC
z7akoc`j0+)ah`baW6QU3AKa=UN6;uoAlXPiWu8bf?_~ZhV8u9b?kZI}cWrYJ@6J6s
zzTjPSQ9S-YT`>NIsIomiQTXe=<Ljq;kFOVf#|tsmi{4{}azGbG`i>U8_4t@N;~TgS
z6|3C`inVUYBy&YQN0hqi+_lZ_+*QW*KLfSsF1Yq=Q(SvW9F%uUyGIU2I8#p6bFg^9
z_<ww=Ft7h){@49~DiD3aqYk=IxBhuw-G=J9B<}sNSVe5mAdl2b(gDN+)Cw|A*`51J
zng6-Ki*UVrUx@<Vb^Z<R31`a7+=q)iqBZ{ffB1BM;=rlA6OZfjo?{5;fq0BTul*+q
zd>GgIPi$B_m#BS5i&ghw@DG`~AsgwYUNgc^?cHKWAA$Lw3%m%|yZ3KZy7q5zP#rGo
zFyj6&xJO=wxa<*a@$)~}ko$*$)4AHfN4Y|dQ@P^tsXPq4*5|t(*B4ZV6SMEwCKdUj
zMlz9Xq@Pj;4nXDuo9)OCnE!A9hFR<0zeNFt4#awitF-$gl$&o9$kF2Ff21LQ-B3eL
z|6oIo7;MPa$LSpC0p|32I`>~ZP22pn-fW`w9owiv7ERU+qyt9XNHR13vmqA!HTS{I
zO3y*nAu)w*Jp%WS?2>!rW%2Pp+?cHloy%$+I-4az$KaXl=R;?*&kmi<SrJLvz7yd8
z_<GH(7o;BO^&;sk+kYeg!>qdxstWRJ$v@#rwHVcAy?TB=Z~Gr@%vw5pKJ$+l+VJ^x
z0<V@abT0er;d9v~qAf3sbovtN1{Jk}Ms<U%8&Na5$w!e69NuJiAKA?QKO%~=-+;VI
zL0ol6?qT<+&B49Q$pv!t`SX8iUFGnFjDe90>x4Om8#C~p#=7a@3t7J&Y0MAn_f3fh
zPZg-h5w*U$0{A4V83TO-$ZmgRFJ}Htuws1e{cw|l-iyvZ>|WO8sL7~K>pz(X{@;kX
z|37v)LwRy3<L;A7YsHhx>H47e`tV_`p85gN{t*AD7qtEp`LcGDe!$cLdy&1L`HvRL
z8TS$Y=*K(AuUffBjaE<m=f%YTL{sL{(dM=PKH8K%J=&Zm{G$o)o6>1~Io6c1X@($S
zE(|slsHh(`Su+Of0L7`J8}0qa+5W@87j~)d=mrJ;)M3PXs>jLh!M&{2V&>n|lK$@4
zm9){(D{I8q$1}#j=#{jeg%xO)#gQ|)D(Xg!>cxKQA3#RxAxW8!ZLs&(G5@o`7S$!4
z|3U}#VhK~(n*qkMPH)JGiGNS)+9XfQny<z_P8FU{Xrx$2>zdtDG5Qnw5+mnwRn&^;
zAD~{;dj^mdv4DDq#|y##Mvnhcu|4yq{^J{zzPdt(?90NpQh$!Pr`jC#der<+wxz!|
zel_I-aPIT8rik&YiWqOjpx3J@zVX(SyAxMa(`HH#`O3)o9CheSmPY*pl8t24V*&Yr
z_29pd`Hu|atatR+tyjRkgK{g0E9}eQo@(}}_}8wdB}`mR`3<-pk$hiE78AkadUCgR
zL-~ogoieKokuHv0$W$SVhMoa*l6ptF4v@@{o%xRhV3_s(Kk59FJyB0q+CJ=z`ZcK8
zqvC(+X8PKRYs%M>^XuUL#%eJcJZ>ict9DCS8b*w;OCy&uRq7*<OwtF){vmXL@|2U{
zzn<+sEP!DaAD_rqz`euo_YLmRw*&v{BJ!`br7WAcu3V6O-vsYBR|&06ACtF|eA=y5
zZQ{%D{oOF)$tB5u<2r2!JtV0E@B@?!$UTJmeEYyD=06gKbFB}Y1poDU4$7?uDCPs(
zp>ycfHOjtCSpKKlQWGX`D!&8w9?AQyB%#r8ye_8XNNS(Dz3R=mK0Dg$qfMDA`bOGt
zBlw4G$OU8^(D#q>nEz;joaMfOkMb4N)(+k86aVPd8~i`Hm=TtLt!;HVc>ll2Hl26L
z`E782Cy~a)(>sa32mdkk4`vb3=4oE1j$B-;jX)=<k34iXGY|((<=Tf%<#YZw8*ouv
z8~7+s0rw8S?E_og_A{toHz)t!+*|Y7<gHcLq^~Di2k%cmP1MKTmE!5Wl?~JPR$0#R
zMIp|tw|JV@s*pt+xtJkk8-{+8p342hk8<t9rwf?>S&@r;aiAer!5*xG@+u?e)BE)o
zW$$)Y{-1qOoS-?9-$QKoYK|muFYR4C1@F)9tq{-dulV2T2P<Og@r9F=_#eHTu8p97
zO#27A572W#=zx9rOdj(e4!|&LlK+Mrhm89&=cl+YZC^ZTN}Iv|)a{gnsawhKfctJ4
z=i%$g?w{QS@8Ev=!SbPRK3o2-`0vE1_IARE=3nw$0sl?u8tosD4>03^^Z{p>e?L(3
zctiZ7rUw6r`-rWCEn=<QvqA5E2LI3QrY26^T6ITqZ}@!4{r%-)8Ux%P`sU9om(4?z
zIUn(S0{)xRG}=od*+@ozEzrRH&k0-<3nu?VXS1bWm3y>v@UPugmcs6<kmLI(-cK2J
zKYd@?J-A=?<+uO&dQuc08`CY5pQNf|SJr5w*h6}9S@!{yqfm`H#P%N(mZ3Kfp2<<*
z`yDd&OWW6dKke0F|Hg0s;z4o(^8KG7-y87zeIwq(=M(q+-+sRAm(Rag_)u)&{}TBC
zJr9(%;Mr`B|DmMDFo)eM7!KL*G5Lp$k*&ez{QPS-lCvgnuD)y9zKr=Y*Mr}Gu+00-
zpO;sE`<K@jB;OAefAT8q|6|xc_LKD(VDeA)&-{nt70X=bKMVW^)qRMwgth16RLMX3
z`!A!%V>f#|l<z<NRL}Lv_Pw7ib9g^r8SxxnEOG_kJ9#Zt#lE73ePwxuK<0tSQQ7{3
zQJUX-i~ZxA9{E=3`+@aXi_SlK`@fvLk?fhIzApNEQ+KG=2mh4wJzUlg-~XfeeR_0H
z>HMc^I6GkBU+)KIvHy<_##!$Q@Q>UdXZ6UoQ1=OWegphZUQaC@zoz_`+|wccsoqD;
z_YAQgwm$*x|KR(4S=>FoS%ot$n*1XkS^0;)4xI=87r6cphhMlgoWC~WKk*-w`vGfD
zOX@WC?yrD<pWNR8|J37^eLkx7@2|Mv{cQPy=lh}Z694c;hW|$n5Yz`6J_r8KG5?{M
zMLQ3+f1KBq*y{ctXSZ5#hNm^<IsCuArz`!x&OhwG*Ly#)AllD~=e~gb2mC+DD*J%M
ze<SlhUwmief3Pj$pZq^^E}Y?^vpmM0z7hYiuQU4WZsKpJ?<Fl*k1w43CjS)wDK-V$
zKl}f1$VFZY@Q?j|fBi@NBmcuWKFL3w<-vIleXl3U_w>%|_0K+CCI8zzkv}2+I|BR%
z$A5D#5cMDX|9OLK@&A7Q;R8_r(fM6E$4O_pCaxQ2J8rG|%6m5{6=yo;{h6^oXvTlt
z{?Y$|k0M<~?8lxJ*Z;BN8GQfj_HXomh=1e&<OAf{t{baIQ3L)%@bllt`^i?L|1+ci
zOJ_lt|9CjS-)3X~$LRkW`#(?6V>SAJW)3LEuO)lY1Hk$1l!b5bM)(5U|BV1p9LqZY
z#{RF_0}Sl{1jhi!<n@$!o!^c_Jo)IvCuu73QSATVZ^>lsN4}rV0pUC_@BhRFuYdoa
z&VLa9)B_Bu0}%tX@vEtC#q~jPJRI2n4c_}R&H(ZLZyd<lY&iR);0%rB{Exp6fPH|m
z=Cr5dEo=Tb(VDiXJ-%>XLZ1IJ&VTspemV<Ie-FUtf5Jf*aV_}#A95+_1N1W>vKQnV
zYff(&Z%Ipy_=^_t2Fd^B!1=$x*$?JFUf74vuYY;4AwOr}be@WHbn0khjyifVTOGTc
zrFwAgdb}wkRXoUw_haIEexf<&RZnx~CX#9NQZ{7FR)^2#sK{N^!LtQxM_aajFMX)E
zz63wa2rvSS03*N%FanGKBftnS0*nA7zz8q`i~u9R2rvSS03*N%FanGKBftnS0*nA7
zzz8q`i~u9R2rvSS03*N%FanGKBftnS0*nA7zz8q`i~u9R2rvSS03*N%FanGKBftnS
z0*nA7zz8q`i~u9R2rvRK1OdT6j6fs=me38`19!=}%{u=sWbTVF_lB%bM3}on)*nWg
zSB0$Gs;u%ZvChAH$vXFi%)PHz*S#yP^NEnTJJY)Ee%m^K7&5PV-@0BUtn($-`FEl7
zm#pi)SFCey=zOJheInC3cZbX$zHME9_`Y=xVJ-67Lgvtz;Pvlbvd(>>^H;3v-j&w*
zM93WCT7JL#ZR;H3Th^=I519+=oD@7rUR&rK;#$@rZrC}*wXA1Gn7<ve{(i_DQ_JrQ
NnbVYi7=b7d_<uUh_F4b{

literal 0
HcmV?d00001

diff --git a/frontend/docs/reference/api-examples.md b/frontend/docs/reference/api-examples.md
deleted file mode 100644
index 6bd8bb5c..00000000
--- a/frontend/docs/reference/api-examples.md
+++ /dev/null
@@ -1,49 +0,0 @@
----
-outline: deep
----
-
-# Runtime API Examples
-
-This page demonstrates usage of some of the runtime APIs provided by VitePress.
-
-The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
-
-```md
-<script setup>
-import { useData } from 'vitepress'
-
-const { theme, page, frontmatter } = useData()
-</script>
-
-## Results
-
-### Theme Data
-<pre>{{ theme }}</pre>
-
-### Page Data
-<pre>{{ page }}</pre>
-
-### Page Frontmatter
-<pre>{{ frontmatter }}</pre>
-```
-
-<script setup>
-import { useData } from 'vitepress'
-
-const { site, theme, page, frontmatter } = useData()
-</script>
-
-## Results
-
-### Theme Data
-<pre>{{ theme }}</pre>
-
-### Page Data
-<pre>{{ page }}</pre>
-
-### Page Frontmatter
-<pre>{{ frontmatter }}</pre>
-
-## More
-
-Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).