chore(docs): update documentations

This commit is contained in:
Jacky 2024-05-08 12:38:35 +08:00
parent 9a13ee601c
commit 29f1b7db89
No known key found for this signature in database
GPG key ID: 215C21B10DF38B4D
9 changed files with 153 additions and 3 deletions

View file

@ -0,0 +1,26 @@
# 集群
自 v2.0.0-beta.23 起,您可以在配置文件的 `cluster` 分區中定義多個環境。
## Node
- 版本:`>= v2.0.0-beta.23`
- 類型: `string`
- 結構:`Scheme://Host(:Port)?name=環境名稱&node_secret=節點密鑰&enabled=是否啟用`
- 範例: `http://10.0.0.1:9000?name=node1&node_secret=my-node-secret&enabled=true`
如果您需要配置多個環境,請參考下面的配置:
```ini
[cluster]
Node = http://10.0.0.1:9000?name=node1&node_secret=my-node-secret&enabled=true
Node = http://10.0.0.2:9000?name=node2&node_secret=my-node-secret&enabled=false
Node = http://10.0.0.3?name=node3&node_secret=my-node-secret&enabled=true
```
預設情況下Nginx UI 將在啟動階段執行環境的創建操作,您也可以在 WebUI 中的環境列表中找到「從配置中加載」按鈕,手動更新環境。
為了避免與資料庫內已經存在的環境衝突Nginx UI 會檢查 Scheme://Host(:Port) 部分是否應是否唯一,
如果不存在,則按照配置進行創建,反之則不會進行任何操作。
注意如果您刪除了配置文件中的某個節點Nginx UI 不會刪除資料庫中的記錄。

View file

@ -98,6 +98,7 @@ JWT 是一種用於驗證用戶身份的標準,它可以在用戶登錄後生
## CertRenewalInterval
- 版本:`>= v2.0.0-beta.22`
- 類型:`int`
- 預設值: `7`
@ -105,7 +106,30 @@ JWT 是一種用於驗證用戶身份的標準,它可以在用戶登錄後生
## RecursiveNameservers
- 版本:`>= v2.0.0-beta.22`
- 類型: `[]string`
- 範例: `8.8.8.8:53,1.1.1.1:53`
此選項用於設定 Nginx UI 在申請證書的 DNS 挑戰步驟所使用的遞迴域名伺服器。在不配置此項目的情況下Nginx UI 使用作業系統的域名伺服器設定。
## SkipInstallation
- 版本:`>= v2.0.0-beta.23`
- 類型:`bool`
- 預設值:`false`
透過將此選項設定為 `true`,您可以跳過 Nginx UI 伺服器的安裝。
當您希望使用相同的配置文件或環境變數將 Nginx UI 部署到多個伺服器時,這非常有用。
預設情況下,如果您啟用了跳過安裝模式,而沒有在伺服器部分設定 `JWTSecret``NodeSecret` 選項,
Nginx UI 將為這兩個選項生成一個隨機的 UUID 值。
此外,如果您也沒有在伺服器部分設定 `Email` 選項,
Nginx UI 將不會創建系統初始的 acme 使用者,這意味著您無法在此伺服器上申請 SSL 證書。
## Name
- 版本:`>= v2.0.0-beta.23`
- 類型:`string`
使用此選項自定義本地伺服器的名稱,以在環境指示器中顯示。