mirror of
https://github.com/0xJacky/nginx-ui.git
synced 2025-05-10 18:05:48 +02:00
Merge pull request #964 from PeterDaveHelloKitchen/zh_TW
This commit is contained in:
commit
63fb823344
29 changed files with 708 additions and 734 deletions
|
@ -75,10 +75,10 @@ Nginx 網路管理介面,由 [0xJacky](https://jackyu.cn/)、[Hintay](https://
|
||||||
### 特色
|
### 特色
|
||||||
|
|
||||||
- 線上檢視伺服器 CPU、記憶體、系統負載、磁碟使用率等指標
|
- 線上檢視伺服器 CPU、記憶體、系統負載、磁碟使用率等指標
|
||||||
- 配置修改後會自動備份,可以對比任意版本或恢復到任意版本
|
- 設定修改後會自動備份,可以對比任意版本或恢復到任意版本
|
||||||
- 支援鏡像操作到多個集群節點,輕鬆管理多伺服器環境
|
- 支援鏡像操作到多個叢集節點,輕鬆管理多伺服器環境
|
||||||
- 導出加密的 Nginx / Nginx UI 配置,方便快速部署和恢復到新環境
|
- 匯出加密的 Nginx/NginxUI 設定,方便快速部署和恢復到新環境
|
||||||
- 增強版線上 ChatGPT 助手,支援多種模型,包括顯示 Deepseek-R1 的思考鏈,幫助您更好地理解和優化配置
|
- 增強版線上 ChatGPT 助手,支援多種模型,包括顯示 Deepseek-R1 的思考鏈,幫助您更好地理解和最佳化設定
|
||||||
- 一鍵申請和自動續簽 Let's encrypt 憑證
|
- 一鍵申請和自動續簽 Let's encrypt 憑證
|
||||||
- 線上編輯 Nginx 設定檔,編輯器支援 Nginx 設定語法醒目提示
|
- 線上編輯 Nginx 設定檔,編輯器支援 Nginx 設定語法醒目提示
|
||||||
- 線上檢視 Nginx 日誌
|
- 線上檢視 Nginx 日誌
|
||||||
|
@ -114,7 +114,7 @@ Nginx 網路管理介面,由 [0xJacky](https://jackyu.cn/)、[Hintay](https://
|
||||||
|
|
||||||
### 使用前注意
|
### 使用前注意
|
||||||
|
|
||||||
Nginx UI 遵循 Debian 的網頁伺服器設定檔標準。建立的網站設定檔將會放置於 Nginx 設定資料夾(自動檢測)下的 `sites-available` 中,啟用後的網站將會建立一份設定檔軟連結檔到 `sites-enabled` 資料夾。您可能需要提前調整設定檔的組織方式。
|
Nginx UI 遵循 Debian 的網頁伺服器設定檔標準。建立的網站設定檔將會放置於 Nginx 設定資料夾(自動偵測)下的 `sites-available` 中,啟用後的網站將會建立一份設定檔軟連結檔到 `sites-enabled` 資料夾。您可能需要提前調整設定檔的組織方式。
|
||||||
|
|
||||||
對於非 Debian (及 Ubuntu) 作業系統,您可能需要將 `nginx.conf` 設定檔中的內容修改為如下所示的 Debian 風格。
|
對於非 Debian (及 Ubuntu) 作業系統,您可能需要將 `nginx.conf` 設定檔中的內容修改為如下所示的 Debian 風格。
|
||||||
|
|
||||||
|
@ -144,7 +144,7 @@ Nginx UI 可在以下作業系統中使用:
|
||||||
|
|
||||||
### 使用方法
|
### 使用方法
|
||||||
|
|
||||||
第一次執行 Nginx UI 時,請在網頁瀏覽器中訪問 `http://<your_server_ip>:<listen_port>` 完成後續設定。
|
第一次執行 Nginx UI 時,請在網頁瀏覽器中存取 `http://<your_server_ip>:<listen_port>` 完成後續設定。
|
||||||
|
|
||||||
#### 透過執行檔案執行
|
#### 透過執行檔案執行
|
||||||
|
|
||||||
|
@ -153,7 +153,7 @@ Nginx UI 可在以下作業系統中使用:
|
||||||
```shell
|
```shell
|
||||||
nginx-ui -config app.ini
|
nginx-ui -config app.ini
|
||||||
```
|
```
|
||||||
在終端使用 `Control+C` 退出 Nginx UI。
|
在終端使用 `Control+C` 結束 Nginx UI。
|
||||||
|
|
||||||
**在背景執行 Nginx UI**
|
**在背景執行 Nginx UI**
|
||||||
|
|
||||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -43,9 +43,9 @@ const members = [
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Nginx UI 是一個全新的 Nginx 網路管理介面,旨在簡化 Nginx 伺服器的管理和配置。它提供實時伺服器統計資料、ChatGPT
|
Nginx UI 是一個全新的 Nginx 網路管理介面,目的是簡化 Nginx 伺服器的管理和設定。它提供即時伺服器統計資料、ChatGPT
|
||||||
助手、一鍵部署、Let's Encrypt 證書的自動續簽以及使用者友好的網站配置編輯工具。此外,Nginx UI 還提供了線上訪問 Nginx
|
助手、一鍵部署、Let's Encrypt 證書的自動續簽以及使用者友好的網站設定編輯工具。此外,Nginx UI 還提供了線上存取 Nginx
|
||||||
日誌、配置檔案的自動測試和重載、網路終端、深色模式和自適應網頁設計等功能。Nginx UI 採用 Go 和 Vue 構建,確保在管理 Nginx
|
日誌、設定檔案的自動測試和過載、網路終端、深色模式和自適應網頁設計等功能。Nginx UI 採用 Go 和 Vue 建構,確保在管理 Nginx
|
||||||
伺服器時提供無縫高效的體驗。
|
伺服器時提供無縫高效的體驗。
|
||||||
|
|
||||||
## 我們的團隊
|
## 我們的團隊
|
||||||
|
@ -55,15 +55,15 @@ Nginx UI 是一個全新的 Nginx 網路管理介面,旨在簡化 Nginx 伺服
|
||||||
## 特色
|
## 特色
|
||||||
|
|
||||||
- 線上檢視伺服器 CPU、記憶體、系統負載、磁碟使用率等指標
|
- 線上檢視伺服器 CPU、記憶體、系統負載、磁碟使用率等指標
|
||||||
- 配置修改後會自動備份,可以對比任意版本或恢復到任意版本
|
- 設定修改後會自動備份,可以對比任意版本或恢復到任意版本
|
||||||
- 支持鏡像操作到多個集群節點,輕鬆管理多伺服器環境
|
- 支援鏡像操作到多個叢集節點,輕鬆管理多伺服器環境
|
||||||
- 導出加密的 Nginx/NginxUI 配置,方便快速部署和恢復到新環境
|
- 匯出加密的 Nginx/NginxUI 設定,方便快速部署和恢復到新環境
|
||||||
- 增強版在線 ChatGPT 助手,支持多種模型,包括顯示 Deepseek-R1 的思考鏈,幫助您更好地理解和優化配置
|
- 增強版線上 ChatGPT 助手,支援多種模型,包括顯示 Deepseek-R1 的思考鏈,幫助您更好地理解和最佳化設定
|
||||||
- 一鍵申請和自動續簽 Let's encrypt 憑證
|
- 一鍵申請和自動續簽 Let's encrypt 憑證
|
||||||
- 線上編輯 Nginx 配置檔案,編輯器支援 Nginx 配置語法突顯
|
- 線上編輯 Nginx 設定檔案,編輯器支援 Nginx 設定語法突顯
|
||||||
- 線上檢視 Nginx 日誌
|
- 線上檢視 Nginx 日誌
|
||||||
- 使用 Go 和 Vue 開發,發行版本為單個可執行檔案
|
- 使用 Go 和 Vue 開發,發行版本為單個可執行檔案
|
||||||
- 儲存配置後自動測試配置檔案並重載 Nginx
|
- 儲存設定後自動測試設定檔案並過載 Nginx
|
||||||
- 基於網頁瀏覽器的高階命令列終端
|
- 基於網頁瀏覽器的高階命令列終端
|
||||||
- 支援暗黑模式
|
- 支援暗黑模式
|
||||||
- 自適應網頁設計
|
- 自適應網頁設計
|
||||||
|
@ -86,13 +86,13 @@ Nginx UI 可在以下作業系統中使用:
|
||||||
|
|
||||||
- 英文
|
- 英文
|
||||||
- 簡體中文
|
- 簡體中文
|
||||||
- 正体中文
|
- 正體中文
|
||||||
|
|
||||||
由於我們並非英文母語者,儘管已盡力確保準確性,仍可能有改進的空間。若您發現任何問題,歡迎提供回饋!
|
由於我們並非英文母語者,儘管已盡力確保準確性,仍可能有改進的空間。若您發現任何問題,歡迎提供回饋!
|
||||||
|
|
||||||
此外,感謝熱心的社群貢獻更多語言支援,歡迎前往 [Weblate](https://weblate.nginxui.com) 瀏覽並參與翻譯,共同打造更完善的多語言體驗!
|
此外,感謝熱心的社群貢獻更多語言支援,歡迎前往 [Weblate](https://weblate.nginxui.com) 瀏覽並參與翻譯,共同打造更完善的多語言體驗!
|
||||||
|
|
||||||
## 構建基於
|
## 建構基於
|
||||||
|
|
||||||
- [The Go Programming Language](https://go.dev)
|
- [The Go Programming Language](https://go.dev)
|
||||||
- [Gin Web Framework](https://gin-gonic.com)
|
- [Gin Web Framework](https://gin-gonic.com)
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# 構建
|
# 建構
|
||||||
|
|
||||||
構建指南僅適用於開發人員或高階使用者。普通使用者應遵循 [快速入門](./getting-started) 指南。
|
建構指南僅適用於開發人員或高階使用者。普通使用者應遵循 [快速入門](./getting-started) 指南。
|
||||||
|
|
||||||
## 依賴
|
## 依賴
|
||||||
|
|
||||||
|
@ -8,12 +8,12 @@
|
||||||
- Golang 版本 1.23 或更高
|
- Golang 版本 1.23 或更高
|
||||||
- node.js 版本 21 或更高
|
- node.js 版本 21 或更高
|
||||||
|
|
||||||
你需要在構建專案之前執行以下命令更新瀏覽器列表資料庫。
|
你需要在建構專案之前執行以下命令更新瀏覽器列表資料庫。
|
||||||
```shell
|
```shell
|
||||||
npx browserslist@latest --update-db
|
npx browserslist@latest --update-db
|
||||||
```
|
```
|
||||||
|
|
||||||
## 構建前端
|
## 建構前端
|
||||||
|
|
||||||
請在 `app` 資料夾中執行以下命令。
|
請在 `app` 資料夾中執行以下命令。
|
||||||
|
|
||||||
|
@ -22,10 +22,10 @@ pnpm install
|
||||||
pnpm build
|
pnpm build
|
||||||
```
|
```
|
||||||
|
|
||||||
## 構建後端
|
## 建構後端
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
在構建後端之前應先構建前端,因為後端將嵌入前端構建的檔案。
|
在建構後端之前應先建構前端,因為後端將嵌入前端建構的檔案。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
請在專案的根資料夾執行以下命令。
|
請在專案的根資料夾執行以下命令。
|
||||||
|
|
|
@ -2,19 +2,19 @@
|
||||||
|
|
||||||
## PageSize
|
## PageSize
|
||||||
|
|
||||||
- 類型: `int`
|
- 類型:`int`
|
||||||
- 預設值: 10
|
- 預設值:10
|
||||||
- 版本: `>=v2.0.0-beta.37`
|
- 版本:`>=v2.0.0-beta.37`
|
||||||
|
|
||||||
此選項用於設置 Nginx UI 中列表分頁的頁面大小。調整頁面大小可以更有效地管理大量數據,但過大的數字會增加伺服器的負載。
|
此選項用於設定 Nginx UI 中列表分頁的頁面大小。調整頁面大小可以更有效地管理大量資料,但過大的數字會增加伺服器的負載。
|
||||||
|
|
||||||
## JwtSecret
|
## JwtSecret
|
||||||
|
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 版本: `>=v2.0.0-beta.37`
|
- 版本:`>=v2.0.0-beta.37`
|
||||||
|
|
||||||
此選項用於配置 Nginx UI 伺服器生成 JWT 的密鑰。
|
此選項用於設定 Nginx UI 伺服器生成 JWT 的金鑰。
|
||||||
|
|
||||||
JWT 是一種驗證用戶身份的標準。用戶登錄後可以生成一個令牌,然後在後續請求中使用該令牌驗證用戶身份。
|
JWT 是一種驗證使用者身份的標準。使用者登入後可以生成一個令牌,然後在後續請求中使用該令牌驗證使用者身份。
|
||||||
|
|
||||||
如果您使用一鍵安裝腳本部署 Nginx UI,腳本將生成一個 UUID 值並將其設置為此選項的值。
|
如果您使用一鍵安裝指令碼部署 Nginx UI,指令碼將生成一個 UUID 值並將其設定為此選項的值。
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
# Auth
|
# Auth
|
||||||
從 v2.0.0-beta.26 版本開始,您可以在配置文件的 `auth` 部分設置授權選項。
|
從 v2.0.0-beta.26 版本開始,您可以在設定檔的 `auth` 部分設定授權選項。
|
||||||
|
|
||||||
## IPWhiteList
|
## IPWhiteList
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
@ -12,18 +12,18 @@ IPWhiteList = 10.0.0.2
|
||||||
IPWhiteList = 2001:0000:130F:0000:0000:09C0:876A:130B
|
IPWhiteList = 2001:0000:130F:0000:0000:09C0:876A:130B
|
||||||
```
|
```
|
||||||
|
|
||||||
默認情況下,如果您沒有設置 IPWhiteList,所有 IP 地址都允許訪問 Nginx UI。
|
預設情況下,如果您沒有設定 IPWhiteList,所有 IP 地址都允許存取 Nginx UI。
|
||||||
一旦您設置了 IPWhiteList,只有列表中和 `127.0.0.1` 的 IP 地址的用戶可以訪問 Nginx UI,
|
一旦您設定了 IPWhiteList,只有列表中和 `127.0.0.1` 的 IP 地址的使用者可以存取 Nginx UI,
|
||||||
其他人將收到 `403 Forbidden` 錯誤。
|
其他人將收到 `403 Forbidden` 錯誤。
|
||||||
|
|
||||||
## BanThresholdMinutes
|
## BanThresholdMinutes
|
||||||
- Type: `int`
|
- Type: `int`
|
||||||
- Default: `10`
|
- Default: `10`
|
||||||
|
|
||||||
默認情況下,如果用戶在 10 分鐘內登錄失敗 10 次,用戶將被禁止登錄 10 分鐘。
|
預設情況下,如果使用者在 10 分鐘內登入失敗 10 次,使用者將被禁止登入 10 分鐘。
|
||||||
|
|
||||||
## MaxAttempts
|
## MaxAttempts
|
||||||
- Type: `int`
|
- Type: `int`
|
||||||
- Default: `10`
|
- Default: `10`
|
||||||
|
|
||||||
默認情況下,如果用戶在 10 分鐘內登錄失敗 10 次,用戶將被禁止登錄 10 分鐘。
|
預設情況下,如果使用者在 10 分鐘內登入失敗 10 次,使用者將被禁止登入 10 分鐘。
|
||||||
|
|
|
@ -1,28 +1,28 @@
|
||||||
# Casdoor
|
# Casdoor
|
||||||
本節介紹如何配置 Casdoor 作為 Nginx UI 的身份驗證提供程序,該功能由 @Jraaay 貢獻。
|
本節介紹如何設定 Casdoor 作為 Nginx UI 的身份驗證提供程式,該功能由 @Jraaay 貢獻。
|
||||||
|
|
||||||
Casdoor 是一個強大的、全面的身份認證解決方案,支持 OAuth 2.0、SAML 2.0、LDAP、AD 和多種社交登錄方式。通過集成 Casdoor,Nginx UI 可以利用這些功能來提升安全性和用戶體驗。
|
Casdoor 是一個強大的、全面的身份認證解決方案,支援 OAuth 2.0、SAML 2.0、LDAP、AD 和多種社交登入方式。透過整合 Casdoor,Nginx UI 可以利用這些功能來提升安全性和使用者體驗。
|
||||||
|
|
||||||
## Endpoint
|
## Endpoint
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
這是 Casdoor 服務器的 URL。您需要確保 Nginx UI 可以訪問此 URL。
|
這是 Casdoor 伺服器的 URL。您需要確保 Nginx UI 可以存取此 URL。
|
||||||
|
|
||||||
## ExternalUrl
|
## ExternalUrl
|
||||||
- 種類:`string`
|
- 種類:`string`
|
||||||
- 版本: `>= v2.0.0-beta.42`
|
- 版本:`>= v2.0.0-beta.42`
|
||||||
|
|
||||||
這是 Casdoor 伺服器的外部 URL。它用於生成重定向 URI,在未配置此選項的情況下,將使用 Endpoint 作為重定向 URI 的基本 URL。
|
這是 Casdoor 伺服器的外部 URL。它用於生成重導向 URI,在未設定此選項的情況下,將使用 Endpoint 作為重導向 URI 的基本 URL。
|
||||||
|
|
||||||
## ClientId
|
## ClientId
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
這是 Casdoor 為您的應用生成的客戶端 ID。它用於在身份驗證過程中標識您的應用。
|
這是 Casdoor 為您的應用程式生成的客戶端 ID。它用於在身份驗證過程中標識您的應用程式。
|
||||||
|
|
||||||
## ClientSecret
|
## ClientSecret
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
這是 Casdoor 為您的應用生成的客戶端密鑰。它是保持您的應用安全所必需的。
|
這是 Casdoor 為您的應用程式生成的客戶端金鑰。它是保持您的應用程式安全所必需的。
|
||||||
|
|
||||||
## Certificate
|
## Certificate
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
@ -32,14 +32,14 @@ Casdoor 是一個強大的、全面的身份認證解決方案,支持 OAuth 2.
|
||||||
## Organization
|
## Organization
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
這是您在 Casdoor 中設置的組織名稱。Casdoor 將使用此信息來處理身份驗證請求。
|
這是您在 Casdoor 中設定的組織名稱。Casdoor 將使用此資訊來處理身份驗證請求。
|
||||||
|
|
||||||
## Application
|
## Application
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
這是您在 Casdoor 中創建的應用名稱。
|
這是您在 Casdoor 中建立的應用程式名稱。
|
||||||
|
|
||||||
## RedirectUri
|
## RedirectUri
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
這是用戶在成功登錄或授權後重定向到的 URI。它應與 Casdoor 應用配置中的重定向 URI 一致。
|
這是使用者在成功登入或授權後重導向到的 URI。它應與 Casdoor 應用程式設定中的重導向 URI 一致。
|
||||||
|
|
|
@ -1,9 +1,9 @@
|
||||||
## CADir
|
## CADir
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 版本:`>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
|
|
||||||
在申請 Let's Encrypt 證書時,我們使用 Let's Encrypt 的默認 CA 地址。
|
在申請 Let's Encrypt 證書時,我們使用 Let's Encrypt 的預設 CA 地址。
|
||||||
如果您需要調試或從其他提供商獲取證書,您可以將 CADir 設置為他們的地址。
|
如果您需要除錯或從其他供應商取得證書,您可以將 CADir 設定為他們的地址。
|
||||||
|
|
||||||
::: tip 提示
|
::: tip 提示
|
||||||
請注意,CADir 提供的地址需要符合 `RFC 8555` 標準。
|
請注意,CADir 提供的地址需要符合 `RFC 8555` 標準。
|
||||||
|
@ -12,24 +12,24 @@
|
||||||
## RecursiveNameservers
|
## RecursiveNameservers
|
||||||
|
|
||||||
- 版本:`>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
- 類型: `[]string`
|
- 類型:`[]string`
|
||||||
- 示例: `8.8.8.8:53,1.1.1.1:53`
|
- 範例:`8.8.8.8:53,1.1.1.1:53`
|
||||||
|
|
||||||
此選項用於設置 Nginx UI 在申請證書的 DNS 挑戰步驟所使用的遞歸域名伺服器。在不配置此項目的情況下,Nginx UI 使用操作系統的域名伺服器設置。
|
此選項用於設定 Nginx UI 在申請證書的 DNS 挑戰步驟所使用的遞迴域名伺服器。在不設定此專案的情況下,Nginx UI 使用作業系統的域名伺服器設定。
|
||||||
|
|
||||||
## CertRenewalInterval
|
## CertRenewalInterval
|
||||||
|
|
||||||
- 版本:`>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
- 類型: `int`
|
- 類型:`int`
|
||||||
- 默認值: `7`
|
- 預設值:`7`
|
||||||
|
|
||||||
此選項用於設置 Let's Encrypt 證書的自動續簽間隔。默認情況下,Nginx UI 每隔 7 天會自動續簽證書。
|
此選項用於設定 Let's Encrypt 證書的自動續簽間隔。預設情況下,Nginx UI 每隔 7 天會自動續簽證書。
|
||||||
|
|
||||||
## HTTPChallengePort
|
## HTTPChallengePort
|
||||||
|
|
||||||
- 版本:`>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
- 類型: `int`
|
- 類型:`int`
|
||||||
- 默認值: `9180`
|
- 預設值:`9180`
|
||||||
|
|
||||||
在獲取 Let's Encrypt 證書時,此選項用於在 HTTP01 挑戰模式中設置後端監聽端口。
|
在取得 Let's Encrypt 證書時,此選項用於在 HTTP01 挑戰模式中設定後端監聽連接埠。
|
||||||
HTTP01 挑戰是 Let's Encrypt 用於驗證您控制請求證書的域的域驗證方法。
|
HTTP01 挑戰是 Let's Encrypt 用於驗證您控制請求證書的域的域驗證方法。
|
||||||
|
|
|
@ -1,16 +1,16 @@
|
||||||
# 集群
|
# 叢集
|
||||||
|
|
||||||
自 v2.0.0-beta.23 起,您可以在配置文件的 `cluster` 分區中定義多個環境。
|
自 v2.0.0-beta.23 起,您可以在設定檔的 `cluster` 分區中定義多個環境。
|
||||||
|
|
||||||
## Node
|
## Node
|
||||||
|
|
||||||
- 版本:`>= v2.0.0-beta.23`
|
- 版本:`>= v2.0.0-beta.23`
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 結構:`Scheme://Host(:Port)?name=環境名稱&node_secret=節點密鑰&enabled=是否啟用`
|
- 結構:`Scheme://Host(:Port)?name=環境名稱&node_secret=節點金鑰&enabled=是否啟用`
|
||||||
- 範例: `http://10.0.0.1:9000?name=node1&node_secret=my-node-secret&enabled=true`
|
- 範例:`http://10.0.0.1:9000?name=node1&node_secret=my-node-secret&enabled=true`
|
||||||
|
|
||||||
|
|
||||||
如果您需要配置多個環境,請參考下面的配置:
|
如果您需要設定多個環境,請參考下面的設定:
|
||||||
```ini
|
```ini
|
||||||
[cluster]
|
[cluster]
|
||||||
Node = http://10.0.0.1:9000?name=node1&node_secret=my-node-secret&enabled=true
|
Node = http://10.0.0.1:9000?name=node1&node_secret=my-node-secret&enabled=true
|
||||||
|
@ -18,9 +18,9 @@ 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
|
Node = http://10.0.0.3?name=node3&node_secret=my-node-secret&enabled=true
|
||||||
```
|
```
|
||||||
|
|
||||||
預設情況下,Nginx UI 將在啟動階段執行環境的創建操作,您也可以在 WebUI 中的環境列表中找到「從配置中加載」按鈕,手動更新環境。
|
預設情況下,Nginx UI 將在啟動階段執行環境的建立操作,您也可以在 WebUI 中的環境列表中找到「從設定中載入」按鈕,手動更新環境。
|
||||||
|
|
||||||
為了避免與資料庫內已經存在的環境衝突,Nginx UI 會檢查 Scheme://Host(:Port) 部分是否應是否唯一,
|
為了避免與資料庫內已經存在的環境衝突,Nginx UI 會檢查 Scheme://Host(:Port) 部分是否應是否唯一,
|
||||||
如果不存在,則按照配置進行創建,反之則不會進行任何操作。
|
如果不存在,則按照設定進行建立,反之則不會進行任何操作。
|
||||||
|
|
||||||
注意:如果您刪除了配置文件中的某個節點,Nginx UI 不會刪除資料庫中的記錄。
|
注意:如果您刪除了設定檔中的某個節點,Nginx UI 不會刪除資料庫中的記錄。
|
||||||
|
|
|
@ -3,4 +3,4 @@
|
||||||
## Secret
|
## Secret
|
||||||
- Type: `string`
|
- Type: `string`
|
||||||
|
|
||||||
如果這個值為空,Nginx UI 將會自動生成一個隨機的密鑰。這個密鑰用於加密存儲在數據庫中的敏感數據。
|
如果這個值為空,Nginx UI 將會自動生成一個隨機的金鑰。這個金鑰用於加密儲存在資料庫中的敏感資料。
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
# Database
|
# Database
|
||||||
|
|
||||||
## Name
|
## Name
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 預設值: `database`
|
- 預設值:`database`
|
||||||
- 版本: `>=v2.0.0-beta.37`
|
- 版本:`>=v2.0.0-beta.37`
|
||||||
|
|
||||||
此選項用於設置 Nginx UI 用於存儲其數據的 sqlite 數據庫的名稱。
|
此選項用於設定 Nginx UI 用於儲存其資料的 sqlite 資料庫的名稱。
|
||||||
|
|
|
@ -5,16 +5,16 @@
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
- 建議:`https://mirror.ghproxy.com/`
|
- 建議:`https://mirror.ghproxy.com/`
|
||||||
|
|
||||||
對於可能在從 Github 下載資源時遇到困難的用戶(如在中國大陸),此選項允許他們為 github.com 設置代理,以提高可訪問性。
|
對於可能在從 Github 下載資源時遇到困難的使用者(如在中國大陸),此選項允許他們為 github.com 設定代理,以提高可存取性。
|
||||||
|
|
||||||
## InsecureSkipVerify
|
## InsecureSkipVerify
|
||||||
|
|
||||||
- 版本:`>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
- 類型:`bool`
|
- 類型:`bool`
|
||||||
|
|
||||||
此選項用於配置 Nginx UI 伺服器在與其他伺服器建立 TLS 連接時是否跳過證書驗證。
|
此選項用於設定 Nginx UI 伺服器在與其他伺服器建立 TLS 連接時是否跳過證書驗證。
|
||||||
|
|
||||||
- 版本:`>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
- 类型: `bool`
|
- 類型:`bool`
|
||||||
|
|
||||||
此选项用于配置 Nginx UI 服务器在与其他服务器建立 TLS 连接时是否跳过证书验证。
|
此選項用於設定 Nginx UI 伺服器在與其他伺服器建立 TLS 連接時是否跳過證書驗證。
|
||||||
|
|
|
@ -1,29 +1,29 @@
|
||||||
# Logrotate
|
# Logrotate
|
||||||
|
|
||||||
在這個部分,我們將介紹 Nginx UI 中關於 logrotate 的配置選項。
|
在這個部分,我們將介紹 Nginx UI 中關於 logrotate 的設定選項。
|
||||||
|
|
||||||
**logrotate** 旨在簡化生成大量日誌文件的系統的管理。
|
**logrotate** 目的是簡化生成大量日誌文件的系統的管理。
|
||||||
它可以按天、周、月或者文件大小來輪轉日誌文件,還可以壓縮、刪除舊的日誌文件,以及發送日誌文件到指定的郵箱。
|
它可以按天、周、月或者文件大小來輪轉日誌文件,還可以壓縮、刪除舊的日誌文件,以及傳送日誌文件到指定的郵箱。
|
||||||
默認情況下,對於在主機上安裝 Nginx UI 的用戶,大多數主流的 Linux 發行版都已集成 logrotate,
|
預設情況下,對於在主機上安裝 Nginx UI 的使用者,大多數主流的 Linux 發行版都已整合 logrotate,
|
||||||
所以你不需要修改任何東西。
|
所以你不需要修改任何東西。
|
||||||
|
|
||||||
對於使用 Docker 容器安裝 Nginx UI 的用戶,你可以手動啟用這個選項。
|
對於使用 Docker 容器安裝 Nginx UI 的使用者,你可以手動啟用這個選項。
|
||||||
Nginx UI 的 crontab 任務調度器將會按照你設定的分鐘間隔執行 logrotate 命令。
|
Nginx UI 的 crontab 任務排程器將會按照你設定的分鐘間隔執行 logrotate 命令。
|
||||||
|
|
||||||
## Enabled
|
## Enabled
|
||||||
- 類型:`bool`
|
- 類型:`bool`
|
||||||
- 默認值:`false`
|
- 預設值:`false`
|
||||||
|
|
||||||
這個選項用於在 Nginx UI 中啟用 logrotate crontab 任務。
|
這個選項用於在 Nginx UI 中啟用 logrotate crontab 任務。
|
||||||
|
|
||||||
## CMD
|
## CMD
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
- 默認值:`logrotate /etc/logrotate.d/nginx`
|
- 預設值:`logrotate /etc/logrotate.d/nginx`
|
||||||
|
|
||||||
這個選項用於在 Nginx UI 中設置 logrotate 命令。
|
這個選項用於在 Nginx UI 中設定 logrotate 命令。
|
||||||
|
|
||||||
## Interval
|
## Interval
|
||||||
- 類型:`int`
|
- 類型:`int`
|
||||||
- 默認值:`1440`
|
- 預設值:`1440`
|
||||||
|
|
||||||
這個選項用於在 Nginx UI 中設置 logrotate crontab 任務的分鐘間隔。
|
這個選項用於在 Nginx UI 中設定 logrotate crontab 任務的分鐘間隔。
|
||||||
|
|
|
@ -1,92 +1,92 @@
|
||||||
# Nginx
|
# Nginx
|
||||||
|
|
||||||
在本節中,我們將介紹 Nginx UI 中關於 Nginx 控制命令、日誌路徑等參數的配置選項。
|
在本節中,我們將介紹 Nginx UI 中關於 Nginx 控制命令、日誌路徑等參數的設定選項。
|
||||||
|
|
||||||
::: tip 提示
|
::: tip 提示
|
||||||
自 v2.0.0-beta.3 版本起,我們將 `nginx_log` 配置項改名為 `nginx`。
|
自 v2.0.0-beta.3 版本起,我們將 `nginx_log` 設定項改名為 `nginx`。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## 日誌
|
## 日誌
|
||||||
Nginx 日誌對於監控、排查問題和維護您的 Web 伺服器至關重要。它們提供了有關伺服器性能、用戶行為和潛在問題的寶貴見解。
|
Nginx 日誌對於監控、排查問題和維護您的 Web 伺服器至關重要。它們提供了有關伺服器效能、使用者行為和潛在問題的寶貴見解。
|
||||||
|
|
||||||
### AccessLogPath
|
### AccessLogPath
|
||||||
|
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
此選項用於為 Nginx UI 設置 Nginx 訪問日誌的路徑,以便我們在線查看日誌內容。
|
此選項用於為 Nginx UI 設定 Nginx 存取日誌的路徑,以便我們線上檢視日誌內容。
|
||||||
|
|
||||||
::: tip 提示
|
::: tip 提示
|
||||||
在 v2 版本中,我們會讀取 `nginx -V` 命令的輸出,以獲取 Nginx 訪問日誌的默認路徑。
|
在 v2 版本中,我們會讀取 `nginx -V` 命令的輸出,以取得 Nginx 存取日誌的預設路徑。
|
||||||
|
|
||||||
如果您需要設置不同的路徑,您可以使用此選項。
|
如果您需要設定不同的路徑,您可以使用此選項。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### ErrorLogPath
|
### ErrorLogPath
|
||||||
|
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
此選項用於為 Nginx UI 設置 Nginx 錯誤日誌的路徑,以便我們在線查看日誌內容。
|
此選項用於為 Nginx UI 設定 Nginx 錯誤日誌的路徑,以便我們線上檢視日誌內容。
|
||||||
|
|
||||||
::: tip 提示
|
::: tip 提示
|
||||||
在 v2 版本中,我們會讀取 `nginx -V` 命令的輸出,以獲取 Nginx 錯誤日誌的默認路徑。
|
在 v2 版本中,我們會讀取 `nginx -V` 命令的輸出,以取得 Nginx 錯誤日誌的預設路徑。
|
||||||
|
|
||||||
如果您需要設置不同的路徑,您可以使用此選項。
|
如果您需要設定不同的路徑,您可以使用此選項。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### LogDirWhiteList
|
### LogDirWhiteList
|
||||||
|
|
||||||
- 類型:`[]string`
|
- 類型:`[]string`
|
||||||
- 版本:`>= v2.0.0-beta.36`
|
- 版本:`>= v2.0.0-beta.36`
|
||||||
- 示例:`/var/log/nginx,/var/log/sites`
|
- 範例:`/var/log/nginx,/var/log/sites`
|
||||||
|
|
||||||
此選項用於為 Nginx UI 設置日誌查看器的目錄白名單。
|
此選項用於為 Nginx UI 設定日誌檢視器的目錄白名單。
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
出於安全原因,您必須指定存儲日誌的目錄。
|
出於安全原因,您必須指定儲存日誌的目錄。
|
||||||
|
|
||||||
只有這些目錄中的日誌可以在線查看。
|
只有這些目錄中的日誌可以線上檢視。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## 服務監控與控制
|
## 服務監控與控制
|
||||||
|
|
||||||
在本節中,我們將會介紹 Nginx UI 中關於 Nginx 服務的監控和控制命令的配置選項。
|
在本節中,我們將會介紹 Nginx UI 中關於 Nginx 服務的監控和控制命令的設定選項。
|
||||||
|
|
||||||
### ConfigDir
|
### ConfigDir
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
此選項用於設置 Nginx 配置文件夾的路徑。
|
此選項用於設定 Nginx 設定資料夾的路徑。
|
||||||
|
|
||||||
在 v2 版本中,我們會讀取 `nginx -V` 命令的輸出,以獲取 Nginx 配置文件的默認路徑。
|
在 v2 版本中,我們會讀取 `nginx -V` 命令的輸出,以取得 Nginx 設定檔的預設路徑。
|
||||||
|
|
||||||
如果您需要覆蓋默認路徑,您可以使用此選項。
|
如果您需要覆蓋預設路徑,您可以使用此選項。
|
||||||
|
|
||||||
### PIDPath
|
### PIDPath
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
此選項用於設置 Nginx PID 文件的路徑。Nginx UI 將通過判斷該文件是否存在來判斷 Nginx 服務的運行狀態。
|
此選項用於設定 Nginx PID 文件的路徑。Nginx UI 將透過判斷該文件是否存在來判斷 Nginx 服務的執行狀態。
|
||||||
|
|
||||||
在 v2 版本中,我們會讀取 `nginx -V` 命令的輸出,以獲取 Nginx PID 文件的默認路徑。
|
在 v2 版本中,我們會讀取 `nginx -V` 命令的輸出,以取得 Nginx PID 文件的預設路徑。
|
||||||
|
|
||||||
如果您需要覆蓋默認路徑,您可以使用此選項。
|
如果您需要覆蓋預設路徑,您可以使用此選項。
|
||||||
|
|
||||||
### TestConfigCmd
|
### TestConfigCmd
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
- 默認值:`nginx -t`
|
- 預設值:`nginx -t`
|
||||||
|
|
||||||
此選項用於設置 Nginx 測試配置的命令。
|
此選項用於設定 Nginx 測試設定的命令。
|
||||||
|
|
||||||
### ReloadCmd
|
### ReloadCmd
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
- 默認值:`nginx -s reload`
|
- 預設值:`nginx -s reload`
|
||||||
|
|
||||||
此選項用於設置 Nginx 重新加載配置的命令。
|
此選項用於設定 Nginx 重新載入設定的命令。
|
||||||
|
|
||||||
### RestartCmd
|
### RestartCmd
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
::: tip 提示
|
::: tip 提示
|
||||||
我們建議使用 systemd 管理 Nginx 的用戶,將這個值設置為 `systemctl restart nginx`。
|
我們建議使用 systemd 管理 Nginx 的使用者,將這個值設定為 `systemctl restart nginx`。
|
||||||
否則,當您在 Nginx UI 中重啟 Nginx 後,將無法在 systemctl 中獲取 Nginx 的準確狀態。
|
否則,當您在 Nginx UI 中重啟 Nginx 後,將無法在 systemctl 中取得 Nginx 的準確狀態。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
若此選項為空,則 Nginx UI 將使用以下命令關閉 Nginx 服務:
|
若此選項為空,則 Nginx UI 將使用以下命令關閉 Nginx 服務:
|
||||||
|
@ -103,15 +103,15 @@ start-stop-daemon --start --quiet --pidfile $PID --exec $SBIN_PATH
|
||||||
|
|
||||||
## Stub Status
|
## Stub Status
|
||||||
|
|
||||||
在本節中,我們將會介紹 Nginx UI 中關於 Nginx stub status 模組的配置選項。
|
在本節中,我們將會介紹 Nginx UI 中關於 Nginx stub status 模組的設定選項。
|
||||||
|
|
||||||
### StubStatusPort
|
### StubStatusPort
|
||||||
- 類型:`uint`
|
- 類型:`uint`
|
||||||
- 默認值:`51820`
|
- 預設值:`51820`
|
||||||
- 版本:`>= v2.0.0-rc.6`
|
- 版本:`>= v2.0.0-rc.6`
|
||||||
|
|
||||||
此選項用於設置 Nginx stub status 模組的端口。stub status 模組提供了 Nginx 的基本狀態信息,Nginx UI 使用這些信息來監控伺服器的性能。
|
此選項用於設定 Nginx stub status 模組的連接埠。stub status 模組提供了 Nginx 的基本狀態資訊,Nginx UI 使用這些資訊來監控伺服器的效能。
|
||||||
|
|
||||||
::: tip 提示
|
::: tip 提示
|
||||||
請確保您設置的端口未被其他服務佔用。
|
請確保您設定的連接埠未被其他服務佔用。
|
||||||
:::
|
:::
|
||||||
|
|
|
@ -4,20 +4,20 @@
|
||||||
- 版本:`>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
- 類型:`string`
|
- 類型:`string`
|
||||||
|
|
||||||
使用此選項自定義本地伺服器的名稱,以在環境指示器中顯示。
|
使用此選項自定義本機伺服器的名稱,以在環境指示器中顯示。
|
||||||
|
|
||||||
## Secret
|
## Secret
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 版本: `>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
|
|
||||||
此密鑰用於驗證 Nginx UI 伺服器之間的通信。
|
此金鑰用於驗證 Nginx UI 伺服器之間的通訊。
|
||||||
此外,您可以使用此密鑰在不使用密碼的情況下訪問 Nginx UI API。
|
此外,您可以使用此金鑰在不使用密碼的情況下存取 Nginx UI API。
|
||||||
|
|
||||||
## SkipInstallation
|
## SkipInstallation
|
||||||
- 類型: `boolean`
|
- 類型:`boolean`
|
||||||
- 版本: `>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
|
|
||||||
將此選項設置為 `true` 可以跳過 Nginx UI 伺服器的安裝。當您希望使用相同的配置文件或環境變數將 Nginx UI 部署到多個伺服器時,這非常有用。
|
將此選項設定為 `true` 可以跳過 Nginx UI 伺服器的安裝。當您希望使用相同的設定檔或環境變數將 Nginx UI 部署到多個伺服器時,這非常有用。
|
||||||
|
|
||||||
預設情況下,如果您啟用了跳過安裝模式但未在伺服器部分設定 `App.JwtSecret` 和 `Node.Secret` 選項,
|
預設情況下,如果您啟用了跳過安裝模式但未在伺服器部分設定 `App.JwtSecret` 和 `Node.Secret` 選項,
|
||||||
Nginx UI 將為這兩個選項生成一個隨機的 UUID 值。
|
Nginx UI 將為這兩個選項生成一個隨機的 UUID 值。
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Open AI
|
# Open AI
|
||||||
|
|
||||||
本節用於設定 ChatGPT 配置。請注意,我們不會檢查您提供的資訊的準確性。如果配置錯誤,可能會導致 API 請求失敗,導致 ChatGPT
|
本節用於設定 ChatGPT 設定。請注意,我們不會檢查您提供的資訊的準確性。如果設定錯誤,可能會導致 API 請求失敗,導致 ChatGPT
|
||||||
助手無法使用。
|
助手無法使用。
|
||||||
|
|
||||||
## BaseUrl
|
## BaseUrl
|
||||||
|
@ -19,7 +19,7 @@
|
||||||
|
|
||||||
- 型別:`string`
|
- 型別:`string`
|
||||||
|
|
||||||
此選項用於為 OpenAI 的 API 配置代理。如果您在國家或地區無法訪問 OpenAI 的 API,可以使用 HTTP 代理並將此選項設定為相應的
|
此選項用於為 OpenAI 的 API 設定代理。如果您在國家或地區無法存取 OpenAI 的 API,可以使用 HTTP 代理並將此選項設定為相應的
|
||||||
URL。
|
URL。
|
||||||
|
|
||||||
## Model
|
## Model
|
||||||
|
@ -27,7 +27,7 @@ URL。
|
||||||
- 型別:`string`
|
- 型別:`string`
|
||||||
- 預設值:`gpt-3.5-turbo`
|
- 預設值:`gpt-3.5-turbo`
|
||||||
|
|
||||||
此選項用於設定 ChatGPT 模型。如果您的帳戶有許可權訪問 `gpt-4` 模型,可以相應地配置此選項。
|
此選項用於設定 ChatGPT 模型。如果您的帳戶有許可權存取 `gpt-4` 模型,可以相應地設定此選項。
|
||||||
|
|
||||||
## APIType
|
## APIType
|
||||||
|
|
||||||
|
|
|
@ -1,114 +1,114 @@
|
||||||
# Server
|
# Server
|
||||||
|
|
||||||
Nginx UI 配置的服務端部分涉及控制 Nginx UI 伺服器的各種設定。在頁面中,我們將討論可用的選項、它們的預設值以及它們的目的。
|
Nginx UI 設定的服務端部分涉及控制 Nginx UI 伺服器的各種設定。在頁面中,我們將討論可用的選項、它們的預設值以及它們的目的。
|
||||||
|
|
||||||
## Host
|
## Host
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 版本: `>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
- 預設值: `0.0.0.0`
|
- 預設值:`0.0.0.0`
|
||||||
|
|
||||||
Nginx UI 伺服器監聽的主機名稱。此選項用於配置 Nginx UI 伺服器監聽傳入 HTTP 請求的主機名稱。更改預設主機名稱可能有助於提升安全性。
|
Nginx UI 伺服器監聽的主機名稱。此選項用於設定 Nginx UI 伺服器監聽傳入 HTTP 請求的主機名稱。更改預設主機名稱可能有助於提升安全性。
|
||||||
|
|
||||||
## Port
|
## Port
|
||||||
- 類型: `uint`
|
- 類型:`uint`
|
||||||
- 版本: `>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
- 預設值: `9000`
|
- 預設值:`9000`
|
||||||
|
|
||||||
此選項用於配置 Nginx UI 伺服器監聽傳入 HTTP 請求的端口。更改預設端口對於避免端口衝突或增強安全性可能很有用。
|
此選項用於設定 Nginx UI 伺服器監聽傳入 HTTP 請求的連接埠。更改預設連接埠對於避免連接埠衝突或增強安全性可能很有用。
|
||||||
|
|
||||||
## RunMode
|
## RunMode
|
||||||
|
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 支援的值: `release`,`debug`
|
- 支援的值:`release`,`debug`
|
||||||
- 預設值: `debug`
|
- 預設值:`debug`
|
||||||
|
|
||||||
此選項用於配置 Nginx UI 伺服器的運行模式,主要影響日誌輸出的級別。
|
此選項用於設定 Nginx UI 伺服器的執行模式,主要影響日誌輸出的級別。
|
||||||
|
|
||||||
Nginx UI 的日誌分為 6 個級別,分別為 `Debug`、`Info`、`Warn`、`Error`、`Panic` 和 `Fatal`,這些日誌級別按照嚴重程度遞增。
|
Nginx UI 的日誌分為 6 個級別,分別為 `Debug`、`Info`、`Warn`、`Error`、`Panic` 和 `Fatal`,這些日誌級別按照嚴重程度遞增。
|
||||||
|
|
||||||
當使用 `debug` 模式時,Nginx UI 將在控制台打印 SQL 及其執行的時間和調用者,`Debug` 級別或更高級別的日誌也會被打印。
|
當使用 `debug` 模式時,Nginx UI 將在控制檯列印 SQL 及其執行的時間和呼叫者,`Debug` 級別或更高階別的日誌也會被列印。
|
||||||
|
|
||||||
當使用 `release` 模式時,Nginx UI 將不會在控制台打印 SQL 的執行時間和調用者,只有 `Info` 級別或更高級別的日誌才會被打印。
|
當使用 `release` 模式時,Nginx UI 將不會在控制檯列印 SQL 的執行時間和呼叫者,只有 `Info` 級別或更高階別的日誌才會被列印。
|
||||||
|
|
||||||
## HttpHost
|
## HttpHost
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 預設值: `0.0.0.0`
|
- 預設值:`0.0.0.0`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Host` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Host` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
Nginx UI 伺服器監聽的主機名稱。此選項用於配置 Nginx UI 伺服器監聽傳入 HTTP 請求的主機名稱。更改預設主機名稱可能有助於提升安全性。
|
Nginx UI 伺服器監聽的主機名稱。此選項用於設定 Nginx UI 伺服器監聽傳入 HTTP 請求的主機名稱。更改預設主機名稱可能有助於提升安全性。
|
||||||
|
|
||||||
## HttpPort
|
## HttpPort
|
||||||
- 類型: `int`
|
- 類型:`int`
|
||||||
- 預設值: `9000`
|
- 預設值:`9000`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Port` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Port` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
此選項用於配置 Nginx UI 伺服器監聽傳入 HTTP 請求的端口。更改預設端口對於避免端口衝突或增強安全性可能很有用。
|
此選項用於設定 Nginx UI 伺服器監聽傳入 HTTP 請求的連接埠。更改預設連接埠對於避免連接埠衝突或增強安全性可能很有用。
|
||||||
|
|
||||||
## JwtSecret
|
## JwtSecret
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `App.JwtSecret` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `App.JwtSecret` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
此選項用於配置 Nginx UI 伺服器用於生成 JWT 的密鑰。
|
此選項用於設定 Nginx UI 伺服器用於生成 JWT 的金鑰。
|
||||||
|
|
||||||
JWT 是一種用於驗證用戶身份的標準,它可以在用戶登入後生成一個 token,然後在後續的請求中使用該 token 來驗證用戶身份。
|
JWT 是一種用於驗證使用者身份的標準,它可以在使用者登入後生成一個 token,然後在後續的請求中使用該 token 來驗證使用者身份。
|
||||||
|
|
||||||
如果您使用一鍵安裝腳本來部署 Nginx UI,腳本將會生成一個 UUID 值並將它設定為此選項的值。
|
如果您使用一鍵安裝指令碼來部署 Nginx UI,指令碼將會生成一個 UUID 值並將它設定為此選項的值。
|
||||||
|
|
||||||
## NodeSecret
|
## NodeSecret
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 版本: `>= v2.0.0-beta.24, <= 2.0.0-beta.36`
|
- 版本:`>= v2.0.0-beta.24, <= 2.0.0-beta.36`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Node.Secret` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Node.Secret` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
此密鑰用於驗證 Nginx UI 伺服器之間的通信。
|
此金鑰用於驗證 Nginx UI 伺服器之間的通訊。
|
||||||
此外,您可以使用此密鑰在不使用密碼的情況下訪問 Nginx UI API。
|
此外,您可以使用此金鑰在不使用密碼的情況下存取 Nginx UI API。
|
||||||
|
|
||||||
## HTTPChallengePort
|
## HTTPChallengePort
|
||||||
|
|
||||||
- 類型: `int`
|
- 類型:`int`
|
||||||
- 預設值: `9180`
|
- 預設值:`9180`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Cert.HTTPChallengePort` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Cert.HTTPChallengePort` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
在獲取 Let's Encrypt 證書時,此選項用於在 HTTP01 挑戰模式中設定後端監聽端口。HTTP01 挑戰是 Let's Encrypt 用於驗證您控制請求證書的域的域驗證方法。
|
在取得 Let's Encrypt 證書時,此選項用於在 HTTP01 挑戰模式中設定後端監聽連接埠。HTTP01 挑戰是 Let's Encrypt 用於驗證您控制請求證書的域的域驗證方法。
|
||||||
|
|
||||||
## Email
|
## Email
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Cert.Email` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Cert.Email` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
在獲取 Let's Encrypt 證書時,此選項用於設定您的電子郵件地址。Let's Encrypt 會將您的電子郵件地址用於通知您證書的到期時間。
|
在取得 Let's Encrypt 證書時,此選項用於設定您的電子郵件地址。Let's Encrypt 會將您的電子郵件地址用於通知您證書的到期時間。
|
||||||
|
|
||||||
## Database
|
## Database
|
||||||
|
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 預設值: `database`
|
- 預設值:`database`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Database.Name` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Database.Name` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
此選項用於設定 Nginx UI 用於存儲其數據的 sqlite 數據庫的名稱。
|
此選項用於設定 Nginx UI 用於儲存其資料的 sqlite 資料庫的名稱。
|
||||||
|
|
||||||
## StartCmd
|
## StartCmd
|
||||||
|
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 預設值: `login`
|
- 預設值:`login`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Terminal.StartCmd` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Terminal.StartCmd` 取代。
|
||||||
|
@ -117,29 +117,29 @@ JWT 是一種用於驗證用戶身份的標準,它可以在用戶登入後生
|
||||||
此選項用於設定 Web 終端的啟動命令。
|
此選項用於設定 Web 終端的啟動命令。
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
出於安全原因,我們將啟動命令設置為 `login`,因此您必須通過 Linux 的預設身份驗證方法登入。如果您不想每次訪問 Web 終端時都輸入用戶名和密碼進行驗證,請將其設定為 `bash` 或 `zsh`(如果已安裝)。
|
出於安全原因,我們將啟動命令設定為 `login`,因此您必須透過 Linux 的預設身份驗證方法登入。如果您不想每次存取 Web 終端時都輸入使用者名稱和密碼進行驗證,請將其設定為 `bash` 或 `zsh`(如果已安裝)。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## PageSize
|
## PageSize
|
||||||
|
|
||||||
- 類型: `int`
|
- 類型:`int`
|
||||||
- 預設值: `10`
|
- 預設值:`10`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `App.PageSize` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `App.PageSize` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
此選項用於設定 Nginx UI 中列表分頁的頁面大小。調整頁面大小有助於更有效地管理大量數據,但是過大的數量可能會增加伺服器的壓力。
|
此選項用於設定 Nginx UI 中列表分頁的頁面大小。調整頁面大小有助於更有效地管理大量資料,但是過大的數量可能會增加伺服器的壓力。
|
||||||
|
|
||||||
## CADir
|
## CADir
|
||||||
|
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Cert.CADir` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Cert.CADir` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
在申請 Let's Encrypt 證書時,我們使用 Let's Encrypt 的預設 CA 地址。如果您需要調試或從其他提供商獲取證書,您可以將 CADir 設定為他們的地址。
|
在申請 Let's Encrypt 證書時,我們使用 Let's Encrypt 的預設 CA 地址。如果您需要除錯或從其他供應商取得證書,您可以將 CADir 設定為他們的地址。
|
||||||
|
|
||||||
::: tip 提示
|
::: tip 提示
|
||||||
請注意,CADir 提供的地址需要符合 `RFC 8555` 標準。
|
請注意,CADir 提供的地址需要符合 `RFC 8555` 標準。
|
||||||
|
@ -147,20 +147,20 @@ JWT 是一種用於驗證用戶身份的標準,它可以在用戶登入後生
|
||||||
|
|
||||||
## GithubProxy
|
## GithubProxy
|
||||||
|
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 建議: `https://mirror.ghproxy.com/`
|
- 建議:`https://mirror.ghproxy.com/`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Http.GithubProxy` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Http.GithubProxy` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
對於可能在從 Github 下載資源時遇到困難的用戶(如在中國大陸),此選項允許他們為 github.com 設定代理,以提高可訪問性。
|
對於可能在從 Github 下載資源時遇到困難的使用者(如在中國大陸),此選項允許他們為 github.com 設定代理,以提高可存取性。
|
||||||
|
|
||||||
## CertRenewalInterval
|
## CertRenewalInterval
|
||||||
|
|
||||||
- 版本: `>= v2.0.0-beta.22, <= 2.0.0-beta.36`
|
- 版本:`>= v2.0.0-beta.22, <= 2.0.0-beta.36`
|
||||||
- 類型: `int`
|
- 類型:`int`
|
||||||
- 預設值: `7`
|
- 預設值:`7`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Cert.CertRenewalInterval` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Cert.CertRenewalInterval` 取代。
|
||||||
|
@ -170,9 +170,9 @@ JWT 是一種用於驗證用戶身份的標準,它可以在用戶登入後生
|
||||||
|
|
||||||
## RecursiveNameservers
|
## RecursiveNameservers
|
||||||
|
|
||||||
- 版本: `>= v2.0.0-beta.22, <= 2.0.0-beta.36`
|
- 版本:`>= v2.0.0-beta.22, <= 2.0.0-beta.36`
|
||||||
- 類型: `[]string`
|
- 類型:`[]string`
|
||||||
- 示例: `8.8.8.8:53,1.1.1.1:53`
|
- 範例:`8.8.8.8:53,1.1.1.1:53`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用
|
已在 `v2.0.0-beta.37` 中廢棄,請使用
|
||||||
|
@ -180,43 +180,43 @@ JWT 是一種用於驗證用戶身份的標準,它可以在用戶登入後生
|
||||||
`Cert.RecursiveNameservers` 取代。
|
`Cert.RecursiveNameservers` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
此選項用於設定 Nginx UI 在申請證書的 DNS 挑戰步驟中所使用的遞歸域名伺服器。在不配置此項目的情況下,Nginx UI 使用操作系統的域名伺服器設置。
|
此選項用於設定 Nginx UI 在申請證書的 DNS 挑戰步驟中所使用的遞迴域名伺服器。在不設定此專案的情況下,Nginx UI 使用作業系統的域名伺服器設定。
|
||||||
|
|
||||||
## SkipInstallation
|
## SkipInstallation
|
||||||
|
|
||||||
- 版本: `>= v2.0.0-beta.23, <= 2.0.0-beta.36`
|
- 版本:`>= v2.0.0-beta.23, <= 2.0.0-beta.36`
|
||||||
- 類型: `bool`
|
- 類型:`bool`
|
||||||
- 預設值: `false`
|
- 預設值:`false`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Node.SkipInstallation` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Node.SkipInstallation` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
通過將此選項設置為 `true`,您可以跳過 Nginx UI 伺服器的安裝。
|
透過將此選項設定為 `true`,您可以跳過 Nginx UI 伺服器的安裝。
|
||||||
當您希望使用相同的配置文件或環境變量將 Nginx UI 部署到多個伺服器時,這非常有用。
|
當您希望使用相同的設定檔或環境變數將 Nginx UI 部署到多個伺服器時,這非常有用。
|
||||||
|
|
||||||
預設情況下,如果您啟用了跳過安裝模式,而沒有在伺服器部分設置 `JWTSecret` 和 `NodeSecret` 選項,Nginx UI 將為這兩個選項生成一個隨機的 UUID 值。
|
預設情況下,如果您啟用了跳過安裝模式,而沒有在伺服器部分設定 `JWTSecret` 和 `NodeSecret` 選項,Nginx UI 將為這兩個選項生成一個隨機的 UUID 值。
|
||||||
|
|
||||||
此外,如果您也沒有在伺服器部分設置 `Email` 選項,Nginx UI 將不會創建系統初始的 acme 用戶,這意味著您無法在此伺服器上申請 SSL 證書。
|
此外,如果您也沒有在伺服器部分設定 `Email` 選項,Nginx UI 將不會建立系統初始的 acme 使用者,這意味著您無法在此伺服器上申請 SSL 證書。
|
||||||
|
|
||||||
## Name
|
## Name
|
||||||
|
|
||||||
- 版本: `>= v2.0.0-beta.23, <= 2.0.0-beta.36`
|
- 版本:`>= v2.0.0-beta.23, <= 2.0.0-beta.36`
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Http.InsecureSkipVerify` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Http.InsecureSkipVerify` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
使用此選項自定義本地伺服器的名稱,以在環境指示器中顯示。
|
使用此選項自定義本機伺服器的名稱,以在環境指示器中顯示。
|
||||||
|
|
||||||
## InsecureSkipVerify
|
## InsecureSkipVerify
|
||||||
|
|
||||||
- 版本: `>= v2.0.0-beta.30, <= 2.0.0-beta.36`
|
- 版本:`>= v2.0.0-beta.30, <= 2.0.0-beta.36`
|
||||||
- 類型: `bool`
|
- 類型:`bool`
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Http.InsecureSkipVerify` 取代。
|
已在 `v2.0.0-beta.37` 中廢棄,請使用 `Http.InsecureSkipVerify` 取代。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
此選項用於配置 Nginx UI 伺服器在與其他伺服器建立 TLS 連接時是否跳過證書驗證。
|
此選項用於設定 Nginx UI 伺服器在與其他伺服器建立 TLS 連接時是否跳過證書驗證。
|
||||||
|
|
|
@ -2,13 +2,13 @@
|
||||||
|
|
||||||
## StartCmd
|
## StartCmd
|
||||||
|
|
||||||
- 類型: `string`
|
- 類型:`string`
|
||||||
- 預設值: `login`
|
- 預設值:`login`
|
||||||
- 版本: `>= v2.0.0-beta.37`
|
- 版本:`>= v2.0.0-beta.37`
|
||||||
|
|
||||||
此選項用於設置 Web 終端的啟動命令。
|
此選項用於設定 Web 終端的啟動命令。
|
||||||
|
|
||||||
::: warning 警告
|
::: warning 警告
|
||||||
出於安全原因,我們將啟動命令設置為 `login`,因此您必須通過 Linux 的預設身份驗證方法登錄。
|
出於安全原因,我們將啟動命令設定為 `login`,因此您必須透過 Linux 的預設身份驗證方法登入。
|
||||||
如果您不想每次訪問 Web 終端時都輸入用戶名和密碼進行驗證,請將其設置為 `bash` 或 `zsh`(如果已安裝)。
|
如果您不想每次存取 Web 終端時都輸入使用者名稱和密碼進行驗證,請將其設定為 `bash` 或 `zsh`(如果已安裝)。
|
||||||
:::
|
:::
|
||||||
|
|
|
@ -10,11 +10,11 @@ Webauthn 是一種無密碼的身份驗證方法,提供了比傳統密碼更
|
||||||
|
|
||||||
Passkey 是使用觸控、面部識別、裝置密碼或 PIN 驗證您身份的 Webauthn 憑證。它們可用作密碼替代品或作為 2FA 方法。
|
Passkey 是使用觸控、面部識別、裝置密碼或 PIN 驗證您身份的 Webauthn 憑證。它們可用作密碼替代品或作為 2FA 方法。
|
||||||
|
|
||||||
## 配置
|
## 設定
|
||||||
|
|
||||||
為確保安全性,不能透過 UI 添加 Webauthn 配置。
|
為確保安全性,不能透過 UI 新增 Webauthn 設定。
|
||||||
|
|
||||||
請在 app.ini 配置檔中手動添加以下內容,並重新啟動 Nginx UI。
|
請在 app.ini 設定檔中手動新增以下內容,並重新啟動 Nginx UI。
|
||||||
|
|
||||||
### RPDisplayName
|
### RPDisplayName
|
||||||
|
|
||||||
|
@ -34,20 +34,20 @@ Passkey 是使用觸控、面部識別、裝置密碼或 PIN 驗證您身份的
|
||||||
|
|
||||||
用於在註冊新憑證時設定依賴方(RP)的來源(origins)。
|
用於在註冊新憑證時設定依賴方(RP)的來源(origins)。
|
||||||
|
|
||||||
完成後,刷新此頁面並再次點擊添加 Passkey。
|
完成後,重新整理此頁面並再次點選新增 Passkey。
|
||||||
|
|
||||||
由於某些瀏覽器的安全策略,除非在 `localhost` 上運行,否則無法在非 HTTPS 網站上使用 Passkey。
|
由於某些瀏覽器的安全策略,除非在 `localhost` 上執行,否則無法在非 HTTPS 網站上使用 Passkey。
|
||||||
|
|
||||||
## 詳細說明
|
## 詳細說明
|
||||||
|
|
||||||
1. **使用 Passkey 的自動 2FA:**
|
1. **使用 Passkey 的自動 2FA:**
|
||||||
|
|
||||||
當您使用 Passkey 登入時,所有後續需要 2FA 的操作將自動使用 Passkey。這意味著您無需在 2FA 對話框中手動點擊「通過 Passkey 進行認證」。
|
當您使用 Passkey 登入時,所有後續需要 2FA 的操作將自動使用 Passkey。這意味著您無需在 2FA 對話框中手動點選「透過 Passkey 進行認證」。
|
||||||
|
|
||||||
2. **刪除 Passkey:**
|
2. **刪除 Passkey:**
|
||||||
|
|
||||||
如果您使用 Passkey 登入後,前往「設定 > 認證」並刪除當前的 Passkey,那麼在當前會話中,Passkey 將不再用於後續的 2FA 驗證。如果已配置基於時間的一次性密碼(TOTP),則將改為使用它;如果未配置,則將關閉 2FA。
|
如果您使用 Passkey 登入後,前往「設定 > 認證」並刪除目前的 Passkey,那麼在目前會話中,Passkey 將不再用於後續的 2FA 驗證。如果已設定基於時間的一次性密碼(TOTP),則將改為使用它;如果未設定,則將關閉 2FA。
|
||||||
|
|
||||||
3. **添加新 Passkey:**
|
3. **新增新 Passkey:**
|
||||||
|
|
||||||
如果您在未使用 Passkey 的情況下登入,然後透過「設定 > 認證」添加新的 Passkey,那麼在當前會話中,新增的 Passkey 將優先用於後續所有的 2FA 驗證。
|
如果您在未使用 Passkey 的情況下登入,然後透過「設定 > 認證」新增新的 Passkey,那麼在目前會話中,新增的 Passkey 將優先用於後續所有的 2FA 驗證。
|
||||||
|
|
|
@ -13,19 +13,19 @@
|
||||||
1. 在 VSCode (Cursor) 中開啟指令面板
|
1. 在 VSCode (Cursor) 中開啟指令面板
|
||||||
- Mac: `Cmd`+`Shift`+`P`
|
- Mac: `Cmd`+`Shift`+`P`
|
||||||
- Windows: `Ctrl`+`Shift`+`P`
|
- Windows: `Ctrl`+`Shift`+`P`
|
||||||
2. 搜尋 `Dev Containers: 重新產生並重新開啟容器` 並點擊
|
2. 搜尋 `Dev Containers: 重新產生並重新開啟容器` 並點選
|
||||||
3. 等待容器啟動
|
3. 等待容器啟動
|
||||||
4. 再次開啟指令面板
|
4. 再次開啟指令面板
|
||||||
- Mac: `Cmd`+`Shift`+`P`
|
- Mac: `Cmd`+`Shift`+`P`
|
||||||
- Windows: `Ctrl`+`Shift`+`P`
|
- Windows: `Ctrl`+`Shift`+`P`
|
||||||
5. 選擇 任務: 執行任務 -> 啟動所有服務
|
5. 選擇 任務:執行任務 -> 啟動所有服務
|
||||||
6. 等待所有服務啟動完成
|
6. 等待所有服務啟動完成
|
||||||
|
|
||||||
## 連接埠映射
|
## 連接連接埠對映
|
||||||
|
|
||||||
| 連接埠 | 服務 |
|
| 連接連接埠 | 服務 |
|
||||||
|-------|-------------------|
|
|-------|-------------------|
|
||||||
| 3002 | 主應用 |
|
| 3002 | 主應用程式 |
|
||||||
| 3003 | 文件 |
|
| 3003 | 文件 |
|
||||||
| 9000 | API 後端 |
|
| 9000 | API 後端 |
|
||||||
|
|
||||||
|
|
|
@ -1,17 +1,17 @@
|
||||||
# 環境變量
|
# 環境變數
|
||||||
|
|
||||||
適用於 v2.0.0-beta.37 及以上版本。
|
適用於 v2.0.0-beta.37 及以上版本。
|
||||||
|
|
||||||
## App
|
## App
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|-----------|-------------------------|
|
|-----------|-------------------------|
|
||||||
| PageSize | NGINX_UI_APP_PAGE_SIZE |
|
| PageSize | NGINX_UI_APP_PAGE_SIZE |
|
||||||
| JwtSecret | NGINX_UI_APP_JWT_SECRET |
|
| JwtSecret | NGINX_UI_APP_JWT_SECRET |
|
||||||
|
|
||||||
## Server
|
## Server
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|---------|--------------------------|
|
|---------|--------------------------|
|
||||||
| Host | NGINX_UI_SERVER_HOST |
|
| Host | NGINX_UI_SERVER_HOST |
|
||||||
| Port | NGINX_UI_SERVER_PORT |
|
| Port | NGINX_UI_SERVER_PORT |
|
||||||
|
@ -19,13 +19,13 @@
|
||||||
|
|
||||||
## Database
|
## Database
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|------|------------------|
|
|------|------------------|
|
||||||
| Name | NGINX_UI_DB_NAME |
|
| Name | NGINX_UI_DB_NAME |
|
||||||
|
|
||||||
## Auth
|
## Auth
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|---------------------|-------------------------------------|
|
|---------------------|-------------------------------------|
|
||||||
| IPWhiteList | NGINX_UI_AUTH_IP_WHITE_LIST |
|
| IPWhiteList | NGINX_UI_AUTH_IP_WHITE_LIST |
|
||||||
| BanThresholdMinutes | NGINX_UI_AUTH_BAN_THRESHOLD_MINUTES |
|
| BanThresholdMinutes | NGINX_UI_AUTH_BAN_THRESHOLD_MINUTES |
|
||||||
|
@ -33,7 +33,7 @@
|
||||||
|
|
||||||
## Casdoor
|
## Casdoor
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|-----------------|-----------------------------------|
|
|-----------------|-----------------------------------|
|
||||||
| Endpoint | NGINX_UI_CASDOOR_ENDPOINT |
|
| Endpoint | NGINX_UI_CASDOOR_ENDPOINT |
|
||||||
| ClientId | NGINX_UI_CASDOOR_CLIENT_ID |
|
| ClientId | NGINX_UI_CASDOOR_CLIENT_ID |
|
||||||
|
@ -45,7 +45,7 @@
|
||||||
|
|
||||||
## Cert
|
## Cert
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|----------------------|-------------------------------------|
|
|----------------------|-------------------------------------|
|
||||||
| Email | NGINX_UI_CERT_EMAIL |
|
| Email | NGINX_UI_CERT_EMAIL |
|
||||||
| CADir | NGINX_UI_CERT_CA_DIR |
|
| CADir | NGINX_UI_CERT_CA_DIR |
|
||||||
|
@ -55,26 +55,26 @@
|
||||||
|
|
||||||
## Cluster
|
## Cluster
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|------|-----------------------|
|
|------|-----------------------|
|
||||||
| Node | NGINX_UI_CLUSTER_NODE |
|
| Node | NGINX_UI_CLUSTER_NODE |
|
||||||
|
|
||||||
## Crypto
|
## Crypto
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|--------|------------------------|
|
|--------|------------------------|
|
||||||
| Secret | NGINX_UI_CRYPTO_SECRET |
|
| Secret | NGINX_UI_CRYPTO_SECRET |
|
||||||
|
|
||||||
## Http
|
## Http
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|--------------------|------------------------------------|
|
|--------------------|------------------------------------|
|
||||||
| GithubProxy | NGINX_UI_HTTP_GITHUB_PROXY |
|
| GithubProxy | NGINX_UI_HTTP_GITHUB_PROXY |
|
||||||
| InsecureSkipVerify | NGINX_UI_HTTP_INSECURE_SKIP_VERIFY |
|
| InsecureSkipVerify | NGINX_UI_HTTP_INSECURE_SKIP_VERIFY |
|
||||||
|
|
||||||
## Logrotate
|
## Logrotate
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|----------|-----------------------------|
|
|----------|-----------------------------|
|
||||||
| Enabled | NGINX_UI_LOGROTATE_ENABLED |
|
| Enabled | NGINX_UI_LOGROTATE_ENABLED |
|
||||||
| CMD | NGINX_UI_LOGROTATE_CMD |
|
| CMD | NGINX_UI_LOGROTATE_CMD |
|
||||||
|
@ -82,7 +82,7 @@
|
||||||
|
|
||||||
## Nginx
|
## Nginx
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|-----------------|-----------------------------------|
|
|-----------------|-----------------------------------|
|
||||||
| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH |
|
| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH |
|
||||||
| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH |
|
| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH |
|
||||||
|
@ -95,7 +95,7 @@
|
||||||
|
|
||||||
## Node
|
## Node
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|------------------|---------------------------------|
|
|------------------|---------------------------------|
|
||||||
| Name | NGINX_UI_NODE_NAME |
|
| Name | NGINX_UI_NODE_NAME |
|
||||||
| Secret | NGINX_UI_NODE_SECRET |
|
| Secret | NGINX_UI_NODE_SECRET |
|
||||||
|
@ -103,7 +103,7 @@
|
||||||
|
|
||||||
## OpenAI
|
## OpenAI
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|---------|--------------------------|
|
|---------|--------------------------|
|
||||||
| Model | NGINX_UI_OPENAI_MODEL |
|
| Model | NGINX_UI_OPENAI_MODEL |
|
||||||
| BaseUrl | NGINX_UI_OPENAI_BASE_URL |
|
| BaseUrl | NGINX_UI_OPENAI_BASE_URL |
|
||||||
|
@ -112,21 +112,21 @@
|
||||||
|
|
||||||
## Terminal
|
## Terminal
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|----------|-----------------------------|
|
|----------|-----------------------------|
|
||||||
| StartCmd | NGINX_UI_TERMINAL_START_CMD |
|
| StartCmd | NGINX_UI_TERMINAL_START_CMD |
|
||||||
|
|
||||||
## Webauthn
|
## Webauthn
|
||||||
|
|
||||||
| 配置 | 環境變量 |
|
| 設定 | 環境變數 |
|
||||||
|---------------|-----------------------------------|
|
|---------------|-----------------------------------|
|
||||||
| RPDisplayName | NGINX_UI_WEBAUTHN_RP_DISPLAY_NAME |
|
| RPDisplayName | NGINX_UI_WEBAUTHN_RP_DISPLAY_NAME |
|
||||||
| RPID | NGINX_UI_WEBAUTHN_RPID |
|
| RPID | NGINX_UI_WEBAUTHN_RPID |
|
||||||
| RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS |
|
| RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS |
|
||||||
|
|
||||||
## 預定義用戶
|
## 預定義使用者
|
||||||
|
|
||||||
在跳過安裝模式下,您可以設定以下環境變量以創建預定義用戶:
|
在跳過安裝模式下,您可以設定以下環境變數以建立預定義使用者:
|
||||||
|
|
||||||
- NGINX_UI_PREDEFINED_USER_NAME
|
- NGINX_UI_PREDEFINED_USER_NAME
|
||||||
- NGINX_UI_PREDEFINED_USER_PASSWORD
|
- NGINX_UI_PREDEFINED_USER_PASSWORD
|
||||||
|
|
|
@ -9,11 +9,11 @@
|
||||||
|
|
||||||
## 使用前注意
|
## 使用前注意
|
||||||
|
|
||||||
Nginx UI 遵循 Debian 的網頁伺服器配置檔案標準。建立的網站配置檔案將會放置於 Nginx
|
Nginx UI 遵循 Debian 的網頁伺服器設定檔案標準。建立的網站設定檔案將會放置於 Nginx
|
||||||
配置資料夾(自動檢測)下的 `sites-available` 中,啟用後的網站將會建立一份配置檔案軟連結檔到 `sites-enabled`
|
設定資料夾(自動偵測)下的 `sites-available` 中,啟用後的網站將會建立一份設定檔案軟連結檔到 `sites-enabled`
|
||||||
資料夾。您可能需要提前調整配置檔案的組織方式。
|
資料夾。您可能需要提前調整設定檔案的組織方式。
|
||||||
|
|
||||||
對於非 Debian (及 Ubuntu) 作業系統,您可能需要將 `nginx.conf` 配置檔案中的內容修改為如下所示的 Debian 風格。
|
對於非 Debian (及 Ubuntu) 作業系統,您可能需要將 `nginx.conf` 設定檔案中的內容修改為如下所示的 Debian 風格。
|
||||||
|
|
||||||
```nginx
|
```nginx
|
||||||
http {
|
http {
|
||||||
|
@ -27,23 +27,23 @@ http {
|
||||||
|
|
||||||
## 安裝
|
## 安裝
|
||||||
|
|
||||||
我們建議Linux使用者使用 [安裝指令碼](./install-script-linux),這樣您可以直接控制主機上的 Nginx。您也可以透過 [Docker 安裝](#使用-docker),
|
我們建議 Linux 使用者使用 [安裝指令碼](./install-script-linux),這樣您可以直接控制主機上的 Nginx。您也可以透過 [Docker 安裝](#使用-docker),
|
||||||
我們提供的映象包含 Nginx 並可以直接使用。對於高階使用者,您也可以在 [最新發行 (latest release)](https://github.com/0xJacky/nginx-ui/releases/latest)
|
我們提供的映象包含 Nginx 並可以直接使用。對於高階使用者,您也可以在 [最新發行 (latest release)](https://github.com/0xJacky/nginx-ui/releases/latest)
|
||||||
中下載最新版本並 [透過執行檔案執行](#透過執行檔案執行),或者 [手動構建](./build)。
|
中下載最新版本並 [透過執行檔案執行](#透過執行檔案執行),或者 [手動建構](./build)。
|
||||||
|
|
||||||
第一次執行 Nginx UI 時,請在瀏覽器中訪問 `http://<your_server_ip>:<listen_port>` 完成後續配置。
|
第一次執行 Nginx UI 時,請在瀏覽器中存取 `http://<your_server_ip>:<listen_port>` 完成後續設定。
|
||||||
|
|
||||||
此外,我們提供了一個使用 Nginx 反向代理 Nginx UI 的 [示例](./nginx-proxy-example),您可在安裝完成後使用。
|
此外,我們提供了一個使用 Nginx 反向代理 Nginx UI 的 [範例](./nginx-proxy-example),您可在安裝完成後使用。
|
||||||
|
|
||||||
|
|
||||||
## 使用 Docker
|
## 使用 Docker
|
||||||
|
|
||||||
您可以在 docker 中使用我們提供的 `uozi/nginx-ui:latest` [映像檔](https://hub.docker.com/r/uozi/nginx-ui)
|
您可以在 docker 中使用我們提供的 `uozi/nginx-ui:latest` [映像檔](https://hub.docker.com/r/uozi/nginx-ui)
|
||||||
,此映像檔基於 `nginx:latest` 構建。您可以直接將其監聽到 80 和 443 埠以取代宿主機上的 Nginx。
|
,此映像檔基於 `nginx:latest` 建構。您可以直接將其監聽到 80 和 443 連接埠以取代宿主機上的 Nginx。
|
||||||
|
|
||||||
::: tip 提示
|
::: tip 提示
|
||||||
|
|
||||||
預設情況下,Nginx UI 會被反向代理到容器的 `8080` 埠。
|
預設情況下,Nginx UI 會被反向代理到容器的 `8080` 連接埠。
|
||||||
首次使用時,對映到 `/etc/nginx` 的目錄必須為空資料夾。
|
首次使用時,對映到 `/etc/nginx` 的目錄必須為空資料夾。
|
||||||
如果你想要託管靜態檔案,可以直接將資料夾對映入容器中。
|
如果你想要託管靜態檔案,可以直接將資料夾對映入容器中。
|
||||||
|
|
||||||
|
@ -56,7 +56,7 @@ http {
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### Docker 部署示例
|
### Docker 部署範例
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -dit \
|
docker run -dit \
|
||||||
|
@ -70,15 +70,15 @@ docker run -dit \
|
||||||
uozi/nginx-ui:latest
|
uozi/nginx-ui:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
在這個示例中,容器的`80`埠和`443`埠分別映射到主機的`8080`埠和`8443`埠。
|
在這個範例中,容器的`80`連接埠和`443`連接埠分別對映到主機的`8080`連接埠和`8443`連接埠。
|
||||||
您需要訪問`http://<your_server_ip>:8080`來訪問 Nginx UI。
|
您需要存取`http://<your_server_ip>:8080`來存取 Nginx UI。
|
||||||
|
|
||||||
## 透過執行檔案執行
|
## 透過執行檔案執行
|
||||||
|
|
||||||
不建議直接執行 Nginx UI 可執行檔案用於非測試目的。
|
不建議直接執行 Nginx UI 可執行檔案用於非測試目的。
|
||||||
我們建議在 Linux 上將其配置為守護程序或使用 [安裝指令碼](./install-script-linux)。
|
我們建議在 Linux 上將其設定為守護程式或使用 [安裝指令碼](./install-script-linux)。
|
||||||
|
|
||||||
### 配置
|
### 設定
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
echo '[server]\nHttpPort = 9000' > app.ini
|
echo '[server]\nHttpPort = 9000' > app.ini
|
||||||
|
@ -86,7 +86,7 @@ echo '[server]\nHttpPort = 9000' > app.ini
|
||||||
|
|
||||||
::: tip 提示
|
::: tip 提示
|
||||||
|
|
||||||
在沒有 `app.ini` 時 Nginx UI 仍然可以啟動,它將使用預設偵聽埠 `9000`。
|
在沒有 `app.ini` 時 Nginx UI 仍然可以啟動,它將使用預設偵聽連接埠 `9000`。
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
|
@ -18,7 +18,7 @@ install.sh install [OPTIONS]
|
||||||
|
|
||||||
| 選項 | |
|
| 選項 | |
|
||||||
|-----------------------|---------------------------------------------------------------------------------------|
|
|-----------------------|---------------------------------------------------------------------------------------|
|
||||||
| `-l, --local <file>` | 從本地檔案安裝 Nginx UI (`string`) |
|
| `-l, --local <file>` | 從本機檔案安裝 Nginx UI (`string`) |
|
||||||
| `-p, --proxy <url>` | 透過代理伺服器下載 (`string`)<br/>例如:`-p http://127.0.0.1:8118` 或 `-p socks5://127.0.0.1:1080` |
|
| `-p, --proxy <url>` | 透過代理伺服器下載 (`string`)<br/>例如:`-p http://127.0.0.1:8118` 或 `-p socks5://127.0.0.1:1080` |
|
||||||
| `-r, --reverse-proxy` | 透過反向代理伺服器下載 (`string`)<br/>例如:`-r https://mirror.ghproxy.com/` |
|
| `-r, --reverse-proxy` | 透過反向代理伺服器下載 (`string`)<br/>例如:`-r https://mirror.ghproxy.com/` |
|
||||||
|
|
||||||
|
@ -29,8 +29,8 @@ install.sh install [OPTIONS]
|
||||||
bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ install
|
bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ install
|
||||||
```
|
```
|
||||||
|
|
||||||
安裝指令碼預設的監聽埠為 `9000`,HTTP Challenge 埠預設為 `9180`。如果出現埠衝突請修改 `/usr/local/etc/nginx-ui/app.ini`,
|
安裝指令碼預設的監聽連接埠為 `9000`,HTTP Challenge 連接埠預設為 `9180`。如果出現連接埠衝突請修改 `/usr/local/etc/nginx-ui/app.ini`,
|
||||||
並使用 `systemctl restart nginx-ui` 重啟 Nginx UI 守護行程。更多有關資訊,請檢視 [配置參考](./config-server)。
|
並使用 `systemctl restart nginx-ui` 重啟 Nginx UI 守護行程。更多有關資訊,請檢視 [設定參考](./config-server)。
|
||||||
|
|
||||||
## 解除安裝
|
## 解除安裝
|
||||||
|
|
||||||
|
@ -48,19 +48,19 @@ install.sh remove [OPTIONS]
|
||||||
|
|
||||||
| 選項 | |
|
| 選項 | |
|
||||||
|-----------|---------------------------------------|
|
|-----------|---------------------------------------|
|
||||||
| `--purge` | 刪除所有 Nginx UI 檔案,包括日誌、配置等 (`boolean`) |
|
| `--purge` | 刪除所有 Nginx UI 檔案,包括日誌、設定等 (`boolean`) |
|
||||||
|
|
||||||
### 快速使用
|
### 快速使用
|
||||||
|
|
||||||
::: code-group
|
::: code-group
|
||||||
|
|
||||||
```shell [移除]
|
```shell [移除]
|
||||||
# 解除安裝 Nginx UI 但保留配置和資料庫檔案
|
# 解除安裝 Nginx UI 但保留設定和資料庫檔案
|
||||||
bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ remove
|
bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ remove
|
||||||
```
|
```
|
||||||
|
|
||||||
```shell [清除]
|
```shell [清除]
|
||||||
# 解除安裝並刪除所有 Nginx UI 檔案,包括配置和資料庫檔案
|
# 解除安裝並刪除所有 Nginx UI 檔案,包括設定和資料庫檔案
|
||||||
bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ remove --purge
|
bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ remove --purge
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# 開源許可
|
# 開源許可
|
||||||
|
|
||||||
此專案基於 GNU Affero Public License v3.0 (AGPLv3)
|
此專案基於 GNU Affero Public License v3.0 (AGPLv3)
|
||||||
許可,請參閱 [LICENSE](https://github.com/0xJacky/nginx-ui/blob/master/LICENSE) 檔案。透過使用、分發或對本專案做出貢獻,表明您已同意本許可證的條款和條件。
|
許可,請參閱 [LICENSE](https://github.com/0xJacky/nginx-ui/blob/master/LICENSE) 檔案。透過使用、分發或對本專案做出貢獻,表明您已同意本授權的條款和條件。
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Nginx 反向代理示例
|
# Nginx 反向代理範例
|
||||||
|
|
||||||
在本指南中,我們將引導您配置 Nginx 伺服器以將 HTTP 流量重定向到 HTTPS,併為監聽在 `http://127.0.0.1:9000/` 上的 Nginx UI
|
在本指南中,我們將引導您設定 Nginx 伺服器以將 HTTP 流量重導向到 HTTPS,併為監聽在 `http://127.0.0.1:9000/` 上的 Nginx UI
|
||||||
設定反向代理。
|
設定反向代理。
|
||||||
|
|
||||||
```nginx
|
```nginx
|
||||||
|
@ -40,14 +40,14 @@ server {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
配置檔案包括兩個 Nginx 伺服器塊。第一個伺服器塊偵聽 80 埠(HTTP),並將所有傳入的 HTTP 請求重定向到 HTTPS。它還監聽 IPv6
|
設定檔案包括兩個 Nginx 伺服器區塊。第一個伺服器區塊偵聽 80 連接埠(HTTP),並將所有傳入的 HTTP 請求重導向到 HTTPS。它還監聽 IPv6
|
||||||
地址。將 `<your_server_name>` 替換為您的伺服器名稱。
|
地址。將 `<your_server_name>` 替換為您的伺服器名稱。
|
||||||
|
|
||||||
第二個伺服器塊監聽 443 埠(HTTPS)以及 HTTP/2 協議。同樣,它也監聽 IPv6 地址。將 `<your_server_name>` 替換為您的伺服器名稱,並將
|
第二個伺服器區塊監聽 443 連接埠(HTTPS)以及 HTTP/2 協議。同樣,它也監聽 IPv6 地址。將 `<your_server_name>` 替換為您的伺服器名稱,並將
|
||||||
SSL 證書和金鑰的路徑替換為 `/path/to/ssl_cert` 和 `/path/to/ssl_cert_key`。
|
SSL 證書和金鑰的路徑替換為 `/path/to/ssl_cert` 和 `/path/to/ssl_cert_key`。
|
||||||
|
|
||||||
此外,配置包括一個 `map` 指令,用於根據 `$http_upgrade` 變數設定 `$connection_upgrade` 變數的值,該變數用於 WebSocket 連線。
|
此外,設定包括一個 `map` 指令,用於根據 `$http_upgrade` 變數設定 `$connection_upgrade` 變數的值,該變數用於 WebSocket 連線。
|
||||||
|
|
||||||
在第二個伺服器塊中,`location /` 部分包含代理設定,將請求轉發到本地埠 `9000`
|
在第二個伺服器區塊中,`location /` 部分包含代理設定,將請求轉發到本機連接埠 `9000`
|
||||||
。代理設定還包括一些用於正確處理轉發請求的信頭,如 `Host`、`X-Real-IP`、`X-Forwarded-For`、`X-Forwarded-Proto`、`Upgrade`
|
。代理設定還包括一些用於正確處理轉發請求的信頭,如 `Host`、`X-Real-IP`、`X-Forwarded-For`、`X-Forwarded-Proto`、`Upgrade`
|
||||||
和 `Connection`。
|
和 `Connection`。
|
||||||
|
|
|
@ -1,24 +1,24 @@
|
||||||
# 配置模板
|
# 設定範本
|
||||||
|
|
||||||
Nginx UI Template 提供了一種開箱即用的配置模板機制。在 NgxConfigEditor 中,我們設計了一個可視化界面,使使用者能夠方便地將模板中的配置插入到當前的配置文件中。
|
Nginx UI Template 提供了一種開箱即用的設定範本機制。在 NgxConfigEditor 中,我們設計了一個視覺化介面,使使用者能夠方便地將範本中的設定插入到目前的設定檔中。
|
||||||
在本指南中,我們將介紹這種配置模板的文件格式和語法規則。
|
在本指南中,我們將介紹這種設定範本的文件格式和語法規則。
|
||||||
配置模板文件存儲在 `template/block` 目錄中,我們歡迎並期待您通過提交 [PR](https://github.com/0xJacky/nginx-ui/pulls) 的形式分享您編寫的配置模板。
|
設定範本文件儲存在 `template/block` 目錄中,我們歡迎並期待您透過提交 [PR](https://github.com/0xJacky/nginx-ui/pulls) 的形式分享您編寫的設定範本。
|
||||||
|
|
||||||
::: tip
|
::: tip
|
||||||
請注意,每次修改或新增配置文件後,需要重新編譯後端以生效。
|
請注意,每次修改或新增設定檔後,需要重新編譯後端以生效。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## 文件格式
|
## 文件格式
|
||||||
|
|
||||||
Nginx UI Template 文件由兩部分組成:文件頭部以及具體的 Nginx 配置。
|
Nginx UI Template 文件由兩部分組成:文件頭部以及具體的 Nginx 設定。
|
||||||
|
|
||||||
以下是一個關於反向代理的配置模板,我們將以此模板為基礎向您介紹 Nginx UI Template 的文件格式及相關語法。
|
以下是一個關於反向代理的設定範本,我們將以此範本為基礎向您介紹 Nginx UI Template 的文件格式及相關語法。
|
||||||
|
|
||||||
```nginx configuration
|
```nginx configuration
|
||||||
# Nginx UI Template Start
|
# Nginx UI Template Start
|
||||||
name = "Reverse Proxy"
|
name = "Reverse Proxy"
|
||||||
author = "@0xJacky"
|
author = "@0xJacky"
|
||||||
description = { en = "Reverse Proxy Config", zh_CN = "反向代理配置"}
|
description = { en = "Reverse Proxy Config", zh_CN = "反向代理設定"}
|
||||||
|
|
||||||
[variables.enableWebSocket]
|
[variables.enableWebSocket]
|
||||||
type = "boolean"
|
type = "boolean"
|
||||||
|
@ -43,7 +43,7 @@ value = "127.0.0.1"
|
||||||
|
|
||||||
[variables.port]
|
[variables.port]
|
||||||
type = "string"
|
type = "string"
|
||||||
name = { en = "Port", zh_CN = "端口"}
|
name = { en = "Port", zh_CN = "連接埠"}
|
||||||
value = 9000
|
value = 9000
|
||||||
# Nginx UI Template End
|
# Nginx UI Template End
|
||||||
|
|
||||||
|
@ -87,21 +87,21 @@ location / {
|
||||||
|
|
||||||
| 欄位 | 描述 | 類型 | 必要 |
|
| 欄位 | 描述 | 類型 | 必要 |
|
||||||
|:----------------------:|:----------------------------------------:|:---------------------------:|:--:|
|
|:----------------------:|:----------------------------------------:|:---------------------------:|:--:|
|
||||||
| `name` | 配置的名稱 | string | 是 |
|
| `name` | 設定的名稱 | string | 是 |
|
||||||
| `author` | 作者 | string | 是 |
|
| `author` | 作者 | string | 是 |
|
||||||
| `description` | 描述,使用 toml 格式的字典來實現多語言描述 | toml 字典 | 是 |
|
| `description` | 描述,使用 toml 格式的字典來實現多語言描述 | toml 字典 | 是 |
|
||||||
| `variables.變量名稱.type` | 變量類型,目前支持 `boolean`, `string` 和 `select` | string | 是 |
|
| `variables.變數名稱.type` | 變數類型,目前支援 `boolean`, `string` 和 `select` | string | 是 |
|
||||||
| `variables.變量名稱.name` | 變量顯示的名稱,是一個 toml 格式的字典,用於支持多語言 | toml 字典 | 是 |
|
| `variables.變數名稱.name` | 變數顯示的名稱,是一個 toml 格式的字典,用於支援多語言 | toml 字典 | 是 |
|
||||||
| `variables.變量名稱.value` | 變量的默認值 | boolean/string (根據 type 定義) | 否 |
|
| `variables.變數名稱.value` | 變數的預設值 | boolean/string (根據 type 定義) | 否 |
|
||||||
| `variables.變量名稱.mask` | 選擇框的選項 | toml 字典 | 否 |
|
| `variables.變數名稱.mask` | 選擇框的選項 | toml 字典 | 否 |
|
||||||
|
|
||||||
示例如下:
|
範例如下:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
# Nginx UI Template Start
|
# Nginx UI Template Start
|
||||||
name = "Reverse Proxy"
|
name = "Reverse Proxy"
|
||||||
author = "@0xJacky"
|
author = "@0xJacky"
|
||||||
description = { en = "Reverse Proxy Config", zh_CN = "反向代理配置"}
|
description = { en = "Reverse Proxy Config", zh_CN = "反向代理設定"}
|
||||||
|
|
||||||
[variables.enableWebSocket]
|
[variables.enableWebSocket]
|
||||||
type = "boolean"
|
type = "boolean"
|
||||||
|
@ -126,35 +126,35 @@ value = "127.0.0.1"
|
||||||
|
|
||||||
[variables.port]
|
[variables.port]
|
||||||
type = "string"
|
type = "string"
|
||||||
name = { en = "Port", zh_CN = "端口"}
|
name = { en = "Port", zh_CN = "連接埠"}
|
||||||
value = 9000
|
value = 9000
|
||||||
# Nginx UI Template End
|
# Nginx UI Template End
|
||||||
```
|
```
|
||||||
|
|
||||||
其中,名稱、作者及描述將會以摘要的形式在配置列表中顯示。
|
其中,名稱、作者及描述將會以摘要的形式在設定列表中顯示。
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
當您點擊「查看」按鈕,界面會顯示一個對話框,如下圖所示。
|
當您點選「檢視」按鈕,介面會顯示一個對話框,如下圖所示。
|
||||||
|
|
||||||
<img src="/assets/nginx-ui-template/zh_TW/config-ui.png" width="350px" title="配置 Modal" />
|
<img src="/assets/nginx-ui-template/zh_TW/config-ui.png" width="350px" title="設定 Modal" />
|
||||||
|
|
||||||
下表展示了變量類型與使用者界面元素的關係:
|
下表展示了變數類型與使用者介面元素的關係:
|
||||||
|
|
||||||
| 類型 | 使用者界面元素 |
|
| 類型 | 使用者介面元素 |
|
||||||
|:---------:|:------:|
|
|:---------:|:------:|
|
||||||
| `boolean` | 開關 |
|
| `boolean` | 開關 |
|
||||||
| `string` | 輸入框 |
|
| `string` | 輸入框 |
|
||||||
| `select` | 選擇框 |
|
| `select` | 選擇框 |
|
||||||
|
|
||||||
|
|
||||||
## Nginx 配置
|
## Nginx 設定
|
||||||
Nginx 配置應該在文件頭部之後提供,這部分將使用 Go 的 `text/template` 庫進行解析。這個庫提供了強大的模板生成能力,包括條件判斷、循環以及複雜的文本處理等。
|
Nginx 設定應該在文件頭部之後提供,這部分將使用 Go 的 `text/template` 涵式庫進行解析。這個涵式庫提供了強大的範本生成能力,包括條件判斷、迴圈以及複雜的文字處理等。
|
||||||
具體語法可以參考 [Go 文件](https://pkg.go.dev/text/template)。
|
具體語法可以參考 [Go 文件](https://pkg.go.dev/text/template)。
|
||||||
|
|
||||||
在頭部中定義的變量可以在這部分中使用,如 `.NoneReferer` 和 `.AllowReferers`。請注意,需要預先在頭部定義變量,才能在這部分中使用。
|
在頭部中定義的變數可以在這部分中使用,如 `.NoneReferer` 和 `.AllowReferers`。請注意,需要預先在頭部定義變數,才能在這部分中使用。
|
||||||
|
|
||||||
示例如下:
|
範例如下:
|
||||||
|
|
||||||
```nginx configuration
|
```nginx configuration
|
||||||
location / {
|
location / {
|
||||||
|
@ -177,13 +177,13 @@ location / {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
當使用者修改前端的表單後,系統將會根據使用者的輸入和配置模板自動生成新的配置內容。
|
當使用者修改前端的表單後,系統將會根據使用者的輸入和設定範本自動生成新的設定內容。
|
||||||
|
|
||||||
除了模板頭部定義的變量,我們還提供了宏定義的變量,如下表所示:
|
除了範本頭部定義的變數,我們還提供了巨集定義的變數,如下表所示:
|
||||||
|
|
||||||
| 變量名 | 描述 |
|
| 變數名 | 描述 |
|
||||||
|:----------:|:-----------------------:|
|
|:----------:|:-----------------------:|
|
||||||
| HTTPPORT | Nginx UI 監聽的端口 |
|
| HTTPPORT | Nginx UI 監聽的連接埠 |
|
||||||
| HTTP01PORT | 用於 HTTP01 Challenge 的端口 |
|
| HTTP01PORT | 用於 HTTP01 Challenge 的連接埠 |
|
||||||
|
|
||||||
上述變量可以直接在配置部分使用,無需在頭部定義。
|
上述變數可以直接在設定部分使用,無需在頭部定義。
|
||||||
|
|
|
@ -6,10 +6,10 @@
|
||||||
.
|
.
|
||||||
├─ docs # 手冊資料夾
|
├─ docs # 手冊資料夾
|
||||||
├─ cmd # 命令列工具
|
├─ cmd # 命令列工具
|
||||||
├─ app # 使用 Vue 3 構建的前端
|
├─ app # 使用 Vue 3 建構的前端
|
||||||
├─ resources # 其他資源,不參與構建
|
├─ resources # 其他資源,不參與建構
|
||||||
├─ template # 用於 Nginx 的模板檔案
|
├─ template # 用於 Nginx 的範本檔案
|
||||||
├─ app.example.ini # 配置檔案的示例
|
├─ app.example.ini # 設定檔案的範例
|
||||||
├─ main.go # 伺服器入口
|
├─ main.go # 伺服器入口
|
||||||
└─ ...
|
└─ ...
|
||||||
```
|
```
|
||||||
|
@ -19,11 +19,11 @@
|
||||||
```
|
```
|
||||||
.
|
.
|
||||||
├─ docs
|
├─ docs
|
||||||
│ ├─ .vitepress # 配置資料夾
|
│ ├─ .vitepress # 設定資料夾
|
||||||
│ │ ├─ config
|
│ │ ├─ config
|
||||||
│ │ └─ theme
|
│ │ └─ theme
|
||||||
│ ├─ public # 資源
|
│ ├─ public # 資源
|
||||||
│ ├─ [language code] # 翻譯,資料夾名為語言程式碼,例如 zh_CN, zh_TW
|
│ ├─ [language code] # 翻譯,資料夾名為語言代碼,例如 zh_CN, zh_TW
|
||||||
│ ├─ guide
|
│ ├─ guide
|
||||||
│ │ └─ *.md # 手冊 markdown 檔案
|
│ │ └─ *.md # 手冊 markdown 檔案
|
||||||
│ └─ index.md # 首頁 markdown 檔案
|
│ └─ index.md # 首頁 markdown 檔案
|
||||||
|
@ -41,13 +41,13 @@
|
||||||
│ │ ├─ assets # 公共資源
|
│ │ ├─ assets # 公共資源
|
||||||
│ │ ├─ components # Vue 元件
|
│ │ ├─ components # Vue 元件
|
||||||
│ │ ├─ language # 翻譯,使用 vue3-gettext
|
│ │ ├─ language # 翻譯,使用 vue3-gettext
|
||||||
│ │ ├─ layouts # Vue 佈局
|
│ │ ├─ layouts # Vue 設定
|
||||||
│ │ ├─ lib # 庫檔案,如幫助函式
|
│ │ ├─ lib # 涵式庫檔案,如幫助函式
|
||||||
│ │ ├─ pinia # 狀態管理
|
│ │ ├─ pinia # 狀態管理
|
||||||
│ │ ├─ routes # Vue 路由
|
│ │ ├─ routes # Vue 路由
|
||||||
│ │ ├─ views # Vue 檢視
|
│ │ ├─ views # Vue 檢視
|
||||||
│ │ ├─ gettext.ts # 定義翻譯
|
│ │ ├─ gettext.ts # 定義翻譯
|
||||||
│ │ ├─ style.css # 集成 tailwind
|
│ │ ├─ style.css # 整合 tailwind
|
||||||
│ │ └─ ...
|
│ │ └─ ...
|
||||||
│ └─ ...
|
│ └─ ...
|
||||||
└─ ...
|
└─ ...
|
||||||
|
@ -59,22 +59,22 @@
|
||||||
.
|
.
|
||||||
├─ internal # 內部包
|
├─ internal # 內部包
|
||||||
├─ api # 向前端提供的 API
|
├─ api # 向前端提供的 API
|
||||||
├─ model # 數據庫模型
|
├─ model # 資料庫模型
|
||||||
├─ query # gen 自動生成的數據庫查詢文件
|
├─ query # gen 自動生成的資料庫查詢文件
|
||||||
├─ router # 路由和中間件
|
├─ router # 路由和中介軟體
|
||||||
├─ settings # 後端配置
|
├─ settings # 後端設定
|
||||||
├─ test # 單元測試
|
├─ test # 單元測試
|
||||||
├─ main.go # 主程序入口
|
├─ main.go # 主程式入口
|
||||||
└─ ...
|
└─ ...
|
||||||
```
|
```
|
||||||
|
|
||||||
## 模板
|
## 範本
|
||||||
|
|
||||||
```
|
```
|
||||||
.
|
.
|
||||||
├─ template
|
├─ template
|
||||||
│ ├─ block # Nginx 塊配置模板
|
│ ├─ block # Nginx 區塊設定範本
|
||||||
│ ├─ conf # Nginx 配置模板
|
│ ├─ conf # Nginx 設定範本
|
||||||
│ └─ template.go # 嵌入模板檔案至後端
|
│ └─ template.go # 嵌入範本檔案至後端
|
||||||
└─ ...
|
└─ ...
|
||||||
```
|
```
|
||||||
|
|
|
@ -1,30 +1,30 @@
|
||||||
# 重置初始用戶密碼
|
# 重設初始使用者密碼
|
||||||
|
|
||||||
`reset-password` 命令允許您將初始管理員賬戶的密碼重置為隨機生成的12位密碼,包含大寫字母、小寫字母、數字和特殊符號。
|
`reset-password` 命令允許您將初始管理員賬戶的密碼重設為隨機生成的 12 位密碼,包含大寫字母、小寫字母、數字和特殊符號。
|
||||||
|
|
||||||
此功能在 `v2.0.0-rc.4` 版本中引入。
|
此功能在 `v2.0.0-rc.4` 版本中引入。
|
||||||
|
|
||||||
## 使用方法
|
## 使用方法
|
||||||
|
|
||||||
要重置初始用戶的密碼,請運行:
|
要重設初始使用者的密碼,請執行:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
nginx-ui reset-password --config=/path/to/app.ini
|
nginx-ui reset-password --config=/path/to/app.ini
|
||||||
```
|
```
|
||||||
|
|
||||||
此命令將:
|
此命令將:
|
||||||
1. 生成一個安全的隨機密碼(12個字符)
|
1. 生成一個安全的隨機密碼(12 個字元)
|
||||||
2. 重置初始用戶賬戶(用戶ID 1)的密碼
|
2. 重設初始使用者賬戶(使用者 ID 1)的密碼
|
||||||
3. 在應用程序日誌中輸出新密碼
|
3. 在應用程式日誌中輸出新密碼
|
||||||
|
|
||||||
## 參數
|
## 參數
|
||||||
|
|
||||||
- `--config`:(必填)Nginx UI 配置文件的路徑
|
- `--config`:(必填)Nginx UI 設定檔的路徑
|
||||||
|
|
||||||
## 示例
|
## 範例
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 使用默認配置文件位置重置密碼
|
# 使用預設設定檔位置重設密碼
|
||||||
nginx-ui reset-password --config=/path/to/app.ini
|
nginx-ui reset-password --config=/path/to/app.ini
|
||||||
|
|
||||||
# 輸出將包含生成的密碼
|
# 輸出將包含生成的密碼
|
||||||
|
@ -33,9 +33,9 @@ nginx-ui reset-password --config=/path/to/app.ini
|
||||||
2025-03-03 03:24:41 INFO user/reset_password.go:92 User: root, Password: X&K^(X0m(E&&
|
2025-03-03 03:24:41 INFO user/reset_password.go:92 User: root, Password: X&K^(X0m(E&&
|
||||||
```
|
```
|
||||||
|
|
||||||
## 配置文件位置
|
## 設定檔位置
|
||||||
|
|
||||||
- 如果您使用 Linux 一鍵安裝腳本安裝的 Nginx UI,配置文件位於:
|
- 如果您使用 Linux 一鍵安裝指令碼安裝的 Nginx UI,設定檔位於:
|
||||||
```
|
```
|
||||||
/usr/local/etc/nginx-ui/app.ini
|
/usr/local/etc/nginx-ui/app.ini
|
||||||
```
|
```
|
||||||
|
@ -47,7 +47,7 @@ nginx-ui reset-password --config=/path/to/app.ini
|
||||||
|
|
||||||
## Docker 使用方法
|
## Docker 使用方法
|
||||||
|
|
||||||
如果您在 Docker 容器中運行 Nginx UI,需要使用 `docker exec` 命令:
|
如果您在 Docker 容器中執行 Nginx UI,需要使用 `docker exec` 命令:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker exec -it <nginx-ui-container> nginx-ui reset-password --config=/etc/nginx-ui/app.ini
|
docker exec -it <nginx-ui-container> nginx-ui reset-password --config=/etc/nginx-ui/app.ini
|
||||||
|
@ -59,5 +59,5 @@ docker exec -it <nginx-ui-container> nginx-ui reset-password --config=/etc/nginx
|
||||||
|
|
||||||
- 如果您忘記了初始管理員密碼,此命令很有用
|
- 如果您忘記了初始管理員密碼,此命令很有用
|
||||||
- 新密碼將顯示在日誌中,請確保立即複製它
|
- 新密碼將顯示在日誌中,請確保立即複製它
|
||||||
- 您必須有權訪問服務器的命令行才能使用此功能
|
- 您必須有權存取伺服器的命令列才能使用此功能
|
||||||
- 數據庫文件必須存在才能使此命令正常工作
|
- 資料庫檔案必須存在才能使此命令正常工作
|
||||||
|
|
|
@ -22,47 +22,47 @@ hero:
|
||||||
|
|
||||||
features:
|
features:
|
||||||
- icon: 📊
|
- icon: 📊
|
||||||
title: 伺服器指標的在線統計
|
title: 伺服器指標的線上統計
|
||||||
details: 實時監控 CPU 使用率、內存使用率、平均負載和磁盤使用情況。
|
details: 即時監控 CPU 使用率、記憶體使用率、平均負載和磁碟使用情況。
|
||||||
- icon: 💾
|
- icon: 💾
|
||||||
title: 配置文件自動備份
|
title: 設定文件自動備份
|
||||||
details: 配置修改後會自動備份,可以對比任意版本或恢復到任意版本。
|
details: 設定修改後會自動備份,可以對比任意版本或恢復到任意版本。
|
||||||
- icon: 🔄
|
- icon: 🔄
|
||||||
title: 集群管理
|
title: 叢集管理
|
||||||
details: 支持鏡像操作到多個集群節點,輕鬆管理多伺服器環境。
|
details: 支援映象操作到多個叢集節點,輕鬆管理多伺服器環境。
|
||||||
- icon: 📤
|
- icon: 📤
|
||||||
title: 導出加密配置
|
title: 匯出加密設定
|
||||||
details: 導出加密的 Nginx/NginxUI 配置,方便快速部署和恢復到新環境。
|
details: 匯出加密的 Nginx/NginxUI 設定,方便快速部署和恢復到新環境。
|
||||||
- icon: 💬
|
- icon: 💬
|
||||||
title: 在線 ChatGPT 助手
|
title: 線上 ChatGPT 助手
|
||||||
details: 支持多種模型,包括顯示 Deepseek-R1 的思考鏈,幫助您更好地理解和優化配置。
|
details: 支援多種模型,包括顯示 Deepseek-R1 的思考鏈,幫助您更好地理解和最佳化設定。
|
||||||
- icon: 🖱️
|
- icon: 🖱️
|
||||||
title: 一鍵部署和自動續期
|
title: 一鍵部署和自動續期
|
||||||
details: 只需一鍵即可輕鬆部署和自動續期 Let's Encrypt 證書。
|
details: 只需一鍵即可輕鬆部署和自動續期 Let's Encrypt 證書。
|
||||||
- icon: 🛠️
|
- icon: 🛠️
|
||||||
title: 在線編輯網站配置
|
title: 線上編輯網站設定
|
||||||
details: 使用我們的 NgxConfigEditor 區塊編輯器或帶有 Nginx 語法高亮的 Ace 代碼編輯器編輯配置。
|
details: 使用我們的 NgxConfigEditor 區塊編輯器或帶有 Nginx 語法高亮的 Ace 程式碼編輯器編輯設定。
|
||||||
- icon: 📜
|
- icon: 📜
|
||||||
title: 在線查看 Nginx 日誌
|
title: 線上檢視 Nginx 日誌
|
||||||
details: 直接在線訪問和查看您的 Nginx 日誌。
|
details: 直接線上存取和檢視您的 Nginx 日誌。
|
||||||
- icon: 💻
|
- icon: 💻
|
||||||
title: 使用 Go 和 Vue 編寫
|
title: 使用 Go 和 Vue 編寫
|
||||||
details: 該平台使用 Go 和 Vue 構建,並作為單個可執行二進制文件分發。
|
details: 該平臺使用 Go 和 Vue 建構,並作為單個可執行二進位制文件分發。
|
||||||
- icon: 🔄
|
- icon: 🔄
|
||||||
title: 自動測試和重新加載配置
|
title: 自動測試和重新載入設定
|
||||||
details: 測試配置文件並在保存更改後自動重新加載 Nginx。
|
details: 測試設定文件並在儲存更改後自動重新載入 Nginx。
|
||||||
- icon: 🖥️
|
- icon: 🖥️
|
||||||
title: 網頁終端
|
title: 網頁終端
|
||||||
details: 訪問基於網頁的終端以便於管理。
|
details: 存取基於網頁的終端以便於管理。
|
||||||
- icon: 🌙
|
- icon: 🌙
|
||||||
title: 暗模式
|
title: 暗模式
|
||||||
details: 啟用暗模式以獲得舒適的用戶體驗。
|
details: 啟用暗模式以獲得舒適的使用者體驗。
|
||||||
- icon: 📱
|
- icon: 📱
|
||||||
title: 響應式網頁設計
|
title: 響應式網頁設計
|
||||||
details: 通過響應式網頁設計在任何設備上享受無縫體驗。
|
details: 透過響應式網頁設計在任何裝置上享受無縫體驗。
|
||||||
- icon: 🔐
|
- icon: 🔐
|
||||||
title: 兩步驗證
|
title: 兩步驟驗證
|
||||||
details: 使用兩步驗證保護敏感操作。
|
details: 使用兩步驟驗證保護敏感操作。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue