Pārlūkot izejas kodu

chore: update docs of auth

Jacky 1 gadu atpakaļ
vecāks
revīzija
d6b22c157c

+ 2 - 1
docs/.vitepress/config/en.ts

@@ -39,7 +39,8 @@ export const enConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
             {text: 'Open AI', link: '/guide/config-openai'},
             {text: 'Casdoor', link: '/guide/config-casdoor'},
             {text: 'Logrotate', link: '/guide/config-logrotate'},
-            {text: 'Cluster', link: '/guide/config-cluster'}
+            {text: 'Cluster', link: '/guide/config-cluster'},
+            {text: 'Auth', link: '/guide/config-auth'}
           ]
         },
         {

+ 2 - 1
docs/.vitepress/config/zh_CN.ts

@@ -44,7 +44,8 @@ export const zhCNConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
             {text: 'Open AI', link: '/zh_CN/guide/config-openai'},
             {text: 'Casdoor', link: '/zh_CN/guide/config-casdoor'},
             {text: 'Logrotate', link: '/zh_CN/guide/config-logrotate'},
-            {text: '集群', link: '/zh_CN/guide/config-cluster'}
+            {text: '集群', link: '/zh_CN/guide/config-cluster'},
+            {text: '认证', link: '/zh_CN/guide/config-auth'}
           ]
         },
         {

+ 2 - 1
docs/.vitepress/config/zh_TW.ts

@@ -43,7 +43,8 @@ export const zhTWConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
             {text: 'Open AI', link: '/zh_TW/guide/config-openai'},
             {text: 'Casdoor', link: '/zh_TW/guide/config-casdoor'},
             {text: 'Logrotate', link: '/zh_TW/guide/config-logrotate'},
-            {text: '集群', link: '/zh_TW/guide/config-cluster'}
+            {text: '集群', link: '/zh_TW/guide/config-cluster'},
+            {text: '認證', link: '/zh_TM/guide/config-auth'}
           ]
         },
         {

+ 18 - 0
docs/guide/config-auth.md

@@ -0,0 +1,18 @@
+# Auth
+From v2.0.0-beta.26, you can authorization settings in the `auth` section of the configuration file.
+
+## IPWhiteList
+- Type: `string`
+- Example: `10.0.0.1`
+
+```ini
+[auth]
+IPWhiteList = 10.0.0.1
+IPWhiteList = 10.0.0.2
+IPWhiteList = 10.0.0.3
+```
+
+By default, if you do not set the `IPWhiteList`, all IP addresses are allowed to access the Nginx UI.
+
+Once you set the `IPWhiteList`, only the users from IP addresses in the list and `127.0.0.1` can access the Nginx UI,
+others will receive a `403 Forbidden` error.

+ 6 - 0
docs/guide/env.md

@@ -63,6 +63,12 @@ Applicable for version v2.0.0-beta.23 and above.
 | CMD                           | NGINX_UI_LOGROTATE_CMD                |
 | Interval                      | NGINX_UI_LOGROTATE_INTERVAL           |
 
+## Auth
+
+| Configuration Setting | Environment Variable        |
+|-----------------------|-----------------------------|
+| IPWhiteList           | NGINX_UI_AUTH_IPWhiteList   |
+
 ## Predefined User
 
 In skip installation mode, you can set the following environment variables to create a predefined user:

+ 3 - 3
docs/package.json

@@ -7,11 +7,11 @@
     "docs:preview": "vitepress preview"
   },
   "dependencies": {
-    "vue": "^3.4.26",
-    "vitepress": "^1.1.4"
+    "vitepress": "^1.3.1",
+    "vue": "^3.4.33"
   },
   "devDependencies": {
-    "@types/node": "^20.12.8",
+    "@types/node": "^20.14.11",
     "less": "^4.2.0"
   },
   "license": "AGPL-3.0",

Failā izmaiņas netiks attēlotas, jo tās ir par lielu
+ 286 - 749
docs/pnpm-lock.yaml


+ 18 - 0
docs/zh_CN/guide/config-auth.md

@@ -0,0 +1,18 @@
+# Auth
+从 v2.0.0-beta.26 版本开始,您可以在配置文件的 `auth` 部分设置授权选项。
+
+## IPWhiteList
+- 类型:`string`
+- 示例:`10.0.0.1`
+
+```ini
+[auth]
+IPWhiteList = 10.0.0.1
+IPWhiteList = 10.0.0.2
+IPWhiteList = 10.0.0.3
+```
+
+默认情况下,如果您没有设置 `IPWhiteList`,所有 IP 地址都允许访问 Nginx UI。
+
+一旦您设置了 `IPWhiteList`,只有列表中和 `127.0.0.1` 的 IP 地址的用户可以访问 Nginx UI,
+其他人将收到 `403 Forbidden` 错误。

+ 7 - 1
docs/zh_CN/guide/env.md

@@ -1,7 +1,7 @@
 # 环境变量
 适用于 v2.0.0-beta.23 及以上版本
 
-## 服务器
+## Server
 
 | Configuration Setting         | Environment Variable                  |
 | ----------------------------- | ------------------------------------- |
@@ -63,6 +63,12 @@
 | CMD                           | NGINX_UI_LOGROTATE_CMD                |
 | Interval                      | NGINX_UI_LOGROTATE_INTERVAL           |
 
+## Auth
+
+| Configuration Setting | Environment Variable        |
+|-----------------------|-----------------------------|
+| IPWhiteList           | NGINX_UI_AUTH_IPWhiteList   |
+
 ## 预定义用户
 
 在跳过安装模式下,您可以设置以下环境变量以创建预定义用户:

+ 17 - 0
docs/zh_TW/guide/config-auth.md

@@ -0,0 +1,17 @@
+# Auth
+從 v2.0.0-beta.26 版本開始,您可以在配置文件的 `auth` 部分設置授權選項。
+
+## IPWhiteList
+- 類型:`string`
+- 範例:`10.0.0.1`
+
+```ini
+[auth]
+IPWhiteList = 10.0.0.1
+IPWhiteList = 10.0.0.2
+IPWhiteList = 10.0.0.3
+```
+
+默認情況下,如果您沒有設置 IPWhiteList,所有 IP 地址都允許訪問 Nginx UI。
+一旦您設置了 IPWhiteList,只有列表中和 `127.0.0.1` 的 IP 地址的用戶可以訪問 Nginx UI,
+其他人將收到 `403 Forbidden` 錯誤。

+ 7 - 1
docs/zh_TW/guide/env.md

@@ -1,7 +1,7 @@
 # 環境變量
 適用於 v2.0.0-beta.23 及以上版本
 
-## 伺服器
+## Server
 
 | Configuration Setting         | Environment Variable                  |
 | ----------------------------- | ------------------------------------- |
@@ -63,6 +63,12 @@
 | CMD                           | NGINX_UI_LOGROTATE_CMD                |
 | Interval                      | NGINX_UI_LOGROTATE_INTERVAL           |
 
+## Auth
+
+| Configuration Setting | Environment Variable        |
+|-----------------------|-----------------------------|
+| IPWhiteList           | NGINX_UI_AUTH_IPWhiteList   |
+
 ## 預定義使用者
 
 在跳過安裝模式下,您可以設置以下環境變量以創建預定義使用者:

Daži faili netika attēloti, jo izmaiņu fails ir pārāk liels