mirrors/nginx-ui
1
0
Fork 0
mirror of https://github.com/0xJacky/nginx-ui.git synced 2025-05-12 02:45:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

chore: update docs

Browse source
This commit is contained in:
Jacky 2024-10-09 08:51:41 +08:00
parent 4951f5af32
commit 96cff98c66
No known key found for this signature in database
GPG key ID: 215C21B10DF38B4D
4 changed files with 100 additions and 95 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/guide/env.md
View file

@ -27,7 +27,7 @@ Applicable for version v2.0.0-beta.23 and above.
## Nginx ## Nginx
| Configuration Setting | Environment Variable | | Configuration Setting | Environment Variable |
|-----------------------|--------------------------------| |-----------------------|-----------------------------------|
| 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 |
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR | | ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
@ -35,6 +35,7 @@ Applicable for version v2.0.0-beta.23 and above.
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD | | TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD | | ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD | | RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
| LogDirWhiteList | NGINX_UI_NGINX_LOG_DIR_WHITE_LIST |
## OpenAI ## OpenAI

13
docs/zh_CN/guide/env.md
View file

@ -1,10 +1,11 @@
# 环境变量 # 环境变量
适用于 v2.0.0-beta.23 及以上版本 适用于 v2.0.0-beta.23 及以上版本
## Server ## Server
| Configuration Setting | Environment Variable | | Configuration Setting | Environment Variable |
|-------------------------| ------------------------------------- | |-----------------------|---------------------------------------|
| HttpPort | NGINX_UI_SERVER_HTTP_PORT | | HttpPort | NGINX_UI_SERVER_HTTP_PORT |
| RunMode | NGINX_UI_SERVER_RUN_MODE | | RunMode | NGINX_UI_SERVER_RUN_MODE |
| JwtSecret | NGINX_UI_SERVER_JWT_SECRET | | JwtSecret | NGINX_UI_SERVER_JWT_SECRET |
@ -26,7 +27,7 @@
## Nginx ## Nginx
| Configuration Setting | Environment Variable | | Configuration Setting | Environment Variable |
| ----------------------------- | ------------------------------------- | |-----------------------|-----------------------------------|
| 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 |
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR | | ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
@ -34,11 +35,12 @@
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD | | TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD | | ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD | | RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
| LogDirWhiteList | NGINX_UI_NGINX_LOG_DIR_WHITE_LIST |
## OpenAI ## OpenAI
| Configuration Setting | Environment Variable | | Configuration Setting | Environment Variable |
| ----------------------------- | ------------------------------------- | |-----------------------|--------------------------|
| Model | NGINX_UI_OPENAI_MODEL | | Model | NGINX_UI_OPENAI_MODEL |
| BaseUrl | NGINX_UI_OPENAI_BASE_URL | | BaseUrl | NGINX_UI_OPENAI_BASE_URL |
| Proxy | NGINX_UI_OPENAI_PROXY | | Proxy | NGINX_UI_OPENAI_PROXY |
@ -59,7 +61,7 @@
## Logrotate ## Logrotate
| Configuration Setting | Environment Variable | | Configuration Setting | Environment Variable |
| ----------------------------- | ------------------------------------- | |-----------------------|-----------------------------|
| Enabled | NGINX_UI_LOGROTATE_ENABLED | | Enabled | NGINX_UI_LOGROTATE_ENABLED |
| CMD | NGINX_UI_LOGROTATE_CMD | | CMD | NGINX_UI_LOGROTATE_CMD |
| Interval | NGINX_UI_LOGROTATE_INTERVAL | | Interval | NGINX_UI_LOGROTATE_INTERVAL |
@ -67,7 +69,7 @@
## Auth ## Auth
| Configuration Setting | Environment Variable | | Configuration Setting | Environment Variable |
|-----------------------|-----------------------------| |-----------------------|---------------------------|
| IPWhiteList | NGINX_UI_AUTH_IPWhiteList | | IPWhiteList | NGINX_UI_AUTH_IPWhiteList |
## Webauthn ## Webauthn
@ -78,7 +80,6 @@
| RPID | NGINX_UI_WEBAUTHN_RPID | | RPID | NGINX_UI_WEBAUTHN_RPID |
| RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS | | RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS |
## 预定义用户 ## 预定义用户
在跳过安装模式下，您可以设置以下环境变量以创建预定义用户： 在跳过安装模式下，您可以设置以下环境变量以创建预定义用户：

13
docs/zh_TW/guide/env.md
View file

@ -1,10 +1,11 @@
# 環境變量 # 環境變量
適用於 v2.0.0-beta.23 及以上版本 適用於 v2.0.0-beta.23 及以上版本
## Server ## Server
| Configuration Setting | Environment Variable | | Configuration Setting | Environment Variable |
|------------------------| ------------------------------------- | |-----------------------|---------------------------------------|
| HttpPort | NGINX_UI_SERVER_HTTP_PORT | | HttpPort | NGINX_UI_SERVER_HTTP_PORT |
| RunMode | NGINX_UI_SERVER_RUN_MODE | | RunMode | NGINX_UI_SERVER_RUN_MODE |
| JwtSecret | NGINX_UI_SERVER_JWT_SECRET | | JwtSecret | NGINX_UI_SERVER_JWT_SECRET |
@ -26,7 +27,7 @@
## Nginx ## Nginx
| Configuration Setting | Environment Variable | | Configuration Setting | Environment Variable |
| ----------------------------- | ------------------------------------- | |-----------------------|-----------------------------------|
| 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 |
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR | | ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
@ -34,11 +35,12 @@
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD | | TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD | | ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD | | RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
| LogDirWhiteList | NGINX_UI_NGINX_LOG_DIR_WHITE_LIST |
## OpenAI ## OpenAI
| Configuration Setting | Environment Variable | | Configuration Setting | Environment Variable |
| ----------------------------- | ------------------------------------- | |-----------------------|--------------------------|
| Model | NGINX_UI_OPENAI_MODEL | | Model | NGINX_UI_OPENAI_MODEL |
| BaseUrl | NGINX_UI_OPENAI_BASE_URL | | BaseUrl | NGINX_UI_OPENAI_BASE_URL |
| Proxy | NGINX_UI_OPENAI_PROXY | | Proxy | NGINX_UI_OPENAI_PROXY |
@ -59,7 +61,7 @@
## Logrotate ## Logrotate
| Configuration Setting | Environment Variable | | Configuration Setting | Environment Variable |
| ----------------------------- | ------------------------------------- | |-----------------------|-----------------------------|
| Enabled | NGINX_UI_LOGROTATE_ENABLED | | Enabled | NGINX_UI_LOGROTATE_ENABLED |
| CMD | NGINX_UI_LOGROTATE_CMD | | CMD | NGINX_UI_LOGROTATE_CMD |
| Interval | NGINX_UI_LOGROTATE_INTERVAL | | Interval | NGINX_UI_LOGROTATE_INTERVAL |
@ -67,7 +69,7 @@
## Auth ## Auth
| Configuration Setting | Environment Variable | | Configuration Setting | Environment Variable |
|-----------------------|-----------------------------| |-----------------------|---------------------------|
| IPWhiteList | NGINX_UI_AUTH_IPWhiteList | | IPWhiteList | NGINX_UI_AUTH_IPWhiteList |
## Webauthn ## Webauthn
@ -78,7 +80,6 @@
| RPID | NGINX_UI_WEBAUTHN_RPID | | RPID | NGINX_UI_WEBAUTHN_RPID |
| RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS | | RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS |
## 預定義使用者 ## 預定義使用者
在跳過安裝模式下，您可以設置以下環境變量以創建預定義使用者： 在跳過安裝模式下，您可以設置以下環境變量以創建預定義使用者：

2
settings/settings_test.go
View file

@ -35,6 +35,7 @@ func TestSetup(t *testing.T) {
_ = os.Setenv("NGINX_UI_NGINX_TEST_CONFIG_CMD", "nginx -t") _ = os.Setenv("NGINX_UI_NGINX_TEST_CONFIG_CMD", "nginx -t")
_ = os.Setenv("NGINX_UI_NGINX_RELOAD_CMD", "nginx -s reload") _ = os.Setenv("NGINX_UI_NGINX_RELOAD_CMD", "nginx -s reload")
_ = os.Setenv("NGINX_UI_NGINX_RESTART_CMD", "nginx -s restart") _ = os.Setenv("NGINX_UI_NGINX_RESTART_CMD", "nginx -s restart")
_ = os.Setenv("NGINX_UI_NGINX_LOG_DIR_WHITE_LIST", "/var/log/nginx")
_ = os.Setenv("NGINX_UI_OPENAI_MODEL", "davinci") _ = os.Setenv("NGINX_UI_OPENAI_MODEL", "davinci")
_ = os.Setenv("NGINX_UI_OPENAI_BASE_URL", "https://api.openai.com") _ = os.Setenv("NGINX_UI_OPENAI_BASE_URL", "https://api.openai.com")
@ -84,6 +85,7 @@ func TestSetup(t *testing.T) {
assert.Equal(t, "nginx -t", NginxSettings.TestConfigCmd) assert.Equal(t, "nginx -t", NginxSettings.TestConfigCmd)
assert.Equal(t, "nginx -s reload", NginxSettings.ReloadCmd) assert.Equal(t, "nginx -s reload", NginxSettings.ReloadCmd)
assert.Equal(t, "nginx -s stop", NginxSettings.RestartCmd) assert.Equal(t, "nginx -s stop", NginxSettings.RestartCmd)
assert.Equal(t, []string{"/var/log/nginx"}, NginxSettings.LogDirWhiteList)
assert.Equal(t, "davinci", OpenAISettings.Model) assert.Equal(t, "davinci", OpenAISettings.Model)
assert.Equal(t, "https://api.openai.com", OpenAISettings.BaseUrl) assert.Equal(t, "https://api.openai.com", OpenAISettings.BaseUrl)