feat(docs): add options descriptions for server settings

0xJacky · May 4, 2024 · 4ad5e77 · 4ad5e77
1 parent 7be4a70
commit 4ad5e77
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 4 deletions.
diff --git a/app/src/layouts/FooterLayout.vue b/app/src/layouts/FooterLayout.vue
@@ -4,12 +4,10 @@ const thisYear = computed(() => new Date().getFullYear())
 
 <template>
   <div class="footer center">
-    Copyright © 2020 - {{ thisYear }} Nginx UI
+    Copyright © 2021 - {{ thisYear }} Nginx UI
   </div>
 </template>
 
 <style scoped>
-.footer {
 
-}
 </style>
diff --git a/docs/.vitepress/theme/Layout.vue b/docs/.vitepress/theme/Layout.vue
@@ -20,7 +20,8 @@ onMounted(async () => {
     && locales[language]
     && !route.path.includes(language)
   ) {
-    await router.go(language + (route.path !== '/' ? route.path : ''))
+    const endWith = import.meta.env.DEV ? '/' : ''
+    await router.go(language + (route.path !== '/' ? route.path : endWith))
   }
 })
 </script>

diff --git a/docs/guide/config-server.md b/docs/guide/config-server.md
@@ -103,3 +103,20 @@ CADir needs to comply with the `RFC 8555` standard.
 
 For users who may experience difficulties downloading resources from GitHub (such as in mainland China), this option
 allows them to set a proxy for github.com to improve accessibility.
+
+## CertRenewalInterval
+
+- Type: `int`
+- Default value: `7`
+
+This option is used to set the automatic renewal interval of the Let's Encrypt certificate.
+By default, Nginx UI will automatically renew the certificate every 7 days.
+
+## RecursiveNameservers
+
+- Type: `[]string`
+- Example: `8.8.8.8:53,1.1.1.1:53`
+
+This option is used to set the recursive nameservers used by
+Nginx UI in the DNS challenge step of applying for a certificate.
+If this option is not configured, Nginx UI will use the nameservers settings of the operating system.
diff --git a/docs/zh_CN/guide/config-server.md b/docs/zh_CN/guide/config-server.md
@@ -94,3 +94,17 @@ JWT 是一种用于验证用户身份的标准，它可以在用户登录后生
 - 建议：`https://mirror.ghproxy.com/`
 
 对于可能在从 Github 下载资源时遇到困难的用户（如在中国大陆），此选项允许他们为 github.com 设置代理，以提高可访问性。
+
+## CertRenewalInterval
+
+- 类型：`int`
+- 默认值: `7`
+
+此选项用于设置 Let's Encrypt 证书的自动续签间隔。默认情况下，Nginx UI 每隔 7 天会自动续签证书。
+
+## RecursiveNameservers
+
+- 类型: `[]string`
+- 示例: `8.8.8.8:53,1.1.1.1:53`
+
+此选项用于设置 Nginx UI 在申请证书的 DNS 挑战步骤所使用的递归域名服务器。在不配置此项目的情况下，Nginx UI 使用操作系统的域名服务器设置。
diff --git a/docs/zh_TW/guide/config-server.md b/docs/zh_TW/guide/config-server.md
@@ -95,3 +95,17 @@ JWT 是一種用於驗證用戶身份的標準，它可以在用戶登錄後生
 - 建議：`https://mirror.ghproxy.com/`
 
 對於可能在從 Github 下載資源時遇到困難的用戶（如在中國大陸），此選項允許他們為 github.com 設置代理，以提高可訪問性。
+
+## CertRenewalInterval
+
+- 類型：`int`
+- 預設值: `7`
+
+此選項用於設定 Let's Encrypt 證書的自動續簽間隔。預設情況下，Nginx UI 每隔 7 天會自動續簽證書。
+
+## RecursiveNameservers
+
+- 類型: `[]string`
+- 範例: `8.8.8.8:53,1.1.1.1:53`
+
+此選項用於設定 Nginx UI 在申請證書的 DNS 挑戰步驟所使用的遞迴域名伺服器。在不配置此項目的情況下，Nginx UI 使用作業系統的域名伺服器設定。