Skip to content

Commit 96cff98

Browse files
0xJacky0xJacky
committed
chore: update docs
1 parent 4951f5a commit 96cff98

File tree

4 files changed

+100
-95
lines changed

4 files changed

+100
-95
lines changed

‎docs/guide/env.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,16 @@ Applicable for version v2.0.0-beta.23 and above.
2626

2727
## Nginx
2828

29-
| Configuration Setting | Environment Variable |
30-
|-----------------------|--------------------------------|
31-
| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH |
32-
| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH |
33-
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
34-
| PIDPath | NGINX_UI_NGINX_PID_PATH |
35-
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
36-
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
37-
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
29+
| Configuration Setting | Environment Variable |
30+
|-----------------------|-----------------------------------|
31+
| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH |
32+
| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH |
33+
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
34+
| PIDPath | NGINX_UI_NGINX_PID_PATH |
35+
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
36+
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
37+
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
38+
| LogDirWhiteList | NGINX_UI_NGINX_LOG_DIR_WHITE_LIST |
3839

3940
## OpenAI
4041

‎docs/zh_CN/guide/env.md‎

Lines changed: 44 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,50 @@
11
# 环境变量
2+
23
适用于 v2.0.0-beta.23 及以上版本
34

45
## Server
56

6-
| Configuration Setting | Environment Variable |
7-
|-------------------------| ------------------------------------- |
8-
| HttpPort | NGINX_UI_SERVER_HTTP_PORT |
9-
| RunMode | NGINX_UI_SERVER_RUN_MODE |
10-
| JwtSecret | NGINX_UI_SERVER_JWT_SECRET |
11-
| HTTPChallengePort | NGINX_UI_SERVER_HTTP_CHALLENGE_PORT |
12-
| StartCmd | NGINX_UI_SERVER_START_CMD |
13-
| Database | NGINX_UI_SERVER_DATABASE |
14-
| CADir | NGINX_UI_SERVER_CA_DIR |
15-
| GithubProxy | NGINX_UI_SERVER_GITHUB_PROXY |
16-
| NodeSecret | NGINX_UI_SERVER_NODE_SECRET |
17-
| Demo | NGINX_UI_SERVER_DEMO |
18-
| PageSize | NGINX_UI_SERVER_PAGE_SIZE |
19-
| HttpHost | NGINX_UI_SERVER_HTTP_HOST |
20-
| CertRenewalInterval | NGINX_UI_SERVER_CERT_RENEWAL_INTERVAL |
21-
| RecursiveNameservers | NGINX_UI_SERVER_RECURSIVE_NAMESERVERS |
22-
| SkipInstallation | NGINX_UI_SERVER_SKIP_INSTALLATION |
23-
| Name | NGINX_UI_SERVER_NAME |
24-
| InsecureSkipVerify | NGINX_UI_SERVER_INSECURE_SKIP_VERIFY |
7+
| Configuration Setting | Environment Variable |
8+
|-----------------------|---------------------------------------|
9+
| HttpPort | NGINX_UI_SERVER_HTTP_PORT |
10+
| RunMode | NGINX_UI_SERVER_RUN_MODE |
11+
| JwtSecret | NGINX_UI_SERVER_JWT_SECRET |
12+
| HTTPChallengePort | NGINX_UI_SERVER_HTTP_CHALLENGE_PORT |
13+
| StartCmd | NGINX_UI_SERVER_START_CMD |
14+
| Database | NGINX_UI_SERVER_DATABASE |
15+
| CADir | NGINX_UI_SERVER_CA_DIR |
16+
| GithubProxy | NGINX_UI_SERVER_GITHUB_PROXY |
17+
| NodeSecret | NGINX_UI_SERVER_NODE_SECRET |
18+
| Demo | NGINX_UI_SERVER_DEMO |
19+
| PageSize | NGINX_UI_SERVER_PAGE_SIZE |
20+
| HttpHost | NGINX_UI_SERVER_HTTP_HOST |
21+
| CertRenewalInterval | NGINX_UI_SERVER_CERT_RENEWAL_INTERVAL |
22+
| RecursiveNameservers | NGINX_UI_SERVER_RECURSIVE_NAMESERVERS |
23+
| SkipInstallation | NGINX_UI_SERVER_SKIP_INSTALLATION |
24+
| Name | NGINX_UI_SERVER_NAME |
25+
| InsecureSkipVerify | NGINX_UI_SERVER_INSECURE_SKIP_VERIFY |
2526

2627
## Nginx
2728

28-
| Configuration Setting | Environment Variable |
29-
| ----------------------------- | ------------------------------------- |
30-
| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH |
31-
| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH |
32-
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
33-
| PIDPath | NGINX_UI_NGINX_PID_PATH |
34-
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
35-
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
36-
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
29+
| Configuration Setting | Environment Variable |
30+
|-----------------------|-----------------------------------|
31+
| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH |
32+
| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH |
33+
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
34+
| PIDPath | NGINX_UI_NGINX_PID_PATH |
35+
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
36+
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
37+
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
38+
| LogDirWhiteList | NGINX_UI_NGINX_LOG_DIR_WHITE_LIST |
3739

3840
## OpenAI
3941

40-
| Configuration Setting | Environment Variable |
41-
| ----------------------------- | ------------------------------------- |
42-
| Model | NGINX_UI_OPENAI_MODEL |
43-
| BaseUrl | NGINX_UI_OPENAI_BASE_URL |
44-
| Proxy | NGINX_UI_OPENAI_PROXY |
45-
| Token | NGINX_UI_OPENAI_TOKEN |
42+
| Configuration Setting | Environment Variable |
43+
|-----------------------|--------------------------|
44+
| Model | NGINX_UI_OPENAI_MODEL |
45+
| BaseUrl | NGINX_UI_OPENAI_BASE_URL |
46+
| Proxy | NGINX_UI_OPENAI_PROXY |
47+
| Token | NGINX_UI_OPENAI_TOKEN |
4648

4749
## Casdoor
4850

@@ -58,17 +60,17 @@
5860

5961
## Logrotate
6062

61-
| Configuration Setting | Environment Variable |
62-
| ----------------------------- | ------------------------------------- |
63-
| Enabled | NGINX_UI_LOGROTATE_ENABLED |
64-
| CMD | NGINX_UI_LOGROTATE_CMD |
65-
| Interval | NGINX_UI_LOGROTATE_INTERVAL |
63+
| Configuration Setting | Environment Variable |
64+
|-----------------------|-----------------------------|
65+
| Enabled | NGINX_UI_LOGROTATE_ENABLED |
66+
| CMD | NGINX_UI_LOGROTATE_CMD |
67+
| Interval | NGINX_UI_LOGROTATE_INTERVAL |
6668

6769
## Auth
6870

69-
| Configuration Setting | Environment Variable |
70-
|-----------------------|-----------------------------|
71-
| IPWhiteList | NGINX_UI_AUTH_IPWhiteList |
71+
| Configuration Setting | Environment Variable |
72+
|-----------------------|---------------------------|
73+
| IPWhiteList | NGINX_UI_AUTH_IPWhiteList |
7274

7375
## Webauthn
7476

@@ -78,7 +80,6 @@
7880
| RPID | NGINX_UI_WEBAUTHN_RPID |
7981
| RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS |
8082

81-
8283
## 预定义用户
8384

8485
在跳过安装模式下，您可以设置以下环境变量以创建预定义用户：

‎docs/zh_TW/guide/env.md‎

Lines changed: 44 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,50 @@
11
# 環境變量
2+
23
適用於 v2.0.0-beta.23 及以上版本
34

45
## Server
56

6-
| Configuration Setting | Environment Variable |
7-
|------------------------| ------------------------------------- |
8-
| HttpPort | NGINX_UI_SERVER_HTTP_PORT |
9-
| RunMode | NGINX_UI_SERVER_RUN_MODE |
10-
| JwtSecret | NGINX_UI_SERVER_JWT_SECRET |
11-
| HTTPChallengePort | NGINX_UI_SERVER_HTTP_CHALLENGE_PORT |
12-
| StartCmd | NGINX_UI_SERVER_START_CMD |
13-
| Database | NGINX_UI_SERVER_DATABASE |
14-
| CADir | NGINX_UI_SERVER_CA_DIR |
15-
| GithubProxy | NGINX_UI_SERVER_GITHUB_PROXY |
16-
| NodeSecret | NGINX_UI_SERVER_NODE_SECRET |
17-
| Demo | NGINX_UI_SERVER_DEMO |
18-
| PageSize | NGINX_UI_SERVER_PAGE_SIZE |
19-
| HttpHost | NGINX_UI_SERVER_HTTP_HOST |
20-
| CertRenewalInterval | NGINX_UI_SERVER_CERT_RENEWAL_INTERVAL |
21-
| RecursiveNameservers | NGINX_UI_SERVER_RECURSIVE_NAMESERVERS |
22-
| SkipInstallation | NGINX_UI_SERVER_SKIP_INSTALLATION |
23-
| Name | NGINX_UI_SERVER_NAME |
24-
| InsecureSkipVerify | NGINX_UI_SERVER_INSECURE_SKIP_VERIFY |
7+
| Configuration Setting | Environment Variable |
8+
|-----------------------|---------------------------------------|
9+
| HttpPort | NGINX_UI_SERVER_HTTP_PORT |
10+
| RunMode | NGINX_UI_SERVER_RUN_MODE |
11+
| JwtSecret | NGINX_UI_SERVER_JWT_SECRET |
12+
| HTTPChallengePort | NGINX_UI_SERVER_HTTP_CHALLENGE_PORT |
13+
| StartCmd | NGINX_UI_SERVER_START_CMD |
14+
| Database | NGINX_UI_SERVER_DATABASE |
15+
| CADir | NGINX_UI_SERVER_CA_DIR |
16+
| GithubProxy | NGINX_UI_SERVER_GITHUB_PROXY |
17+
| NodeSecret | NGINX_UI_SERVER_NODE_SECRET |
18+
| Demo | NGINX_UI_SERVER_DEMO |
19+
| PageSize | NGINX_UI_SERVER_PAGE_SIZE |
20+
| HttpHost | NGINX_UI_SERVER_HTTP_HOST |
21+
| CertRenewalInterval | NGINX_UI_SERVER_CERT_RENEWAL_INTERVAL |
22+
| RecursiveNameservers | NGINX_UI_SERVER_RECURSIVE_NAMESERVERS |
23+
| SkipInstallation | NGINX_UI_SERVER_SKIP_INSTALLATION |
24+
| Name | NGINX_UI_SERVER_NAME |
25+
| InsecureSkipVerify | NGINX_UI_SERVER_INSECURE_SKIP_VERIFY |
2526

2627
## Nginx
2728

28-
| Configuration Setting | Environment Variable |
29-
| ----------------------------- | ------------------------------------- |
30-
| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH |
31-
| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH |
32-
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
33-
| PIDPath | NGINX_UI_NGINX_PID_PATH |
34-
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
35-
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
36-
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
29+
| Configuration Setting | Environment Variable |
30+
|-----------------------|-----------------------------------|
31+
| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH |
32+
| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH |
33+
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
34+
| PIDPath | NGINX_UI_NGINX_PID_PATH |
35+
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
36+
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
37+
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
38+
| LogDirWhiteList | NGINX_UI_NGINX_LOG_DIR_WHITE_LIST |
3739

3840
## OpenAI
3941

40-
| Configuration Setting | Environment Variable |
41-
| ----------------------------- | ------------------------------------- |
42-
| Model | NGINX_UI_OPENAI_MODEL |
43-
| BaseUrl | NGINX_UI_OPENAI_BASE_URL |
44-
| Proxy | NGINX_UI_OPENAI_PROXY |
45-
| Token | NGINX_UI_OPENAI_TOKEN |
42+
| Configuration Setting | Environment Variable |
43+
|-----------------------|--------------------------|
44+
| Model | NGINX_UI_OPENAI_MODEL |
45+
| BaseUrl | NGINX_UI_OPENAI_BASE_URL |
46+
| Proxy | NGINX_UI_OPENAI_PROXY |
47+
| Token | NGINX_UI_OPENAI_TOKEN |
4648

4749
## Casdoor
4850

@@ -58,17 +60,17 @@
5860

5961
## Logrotate
6062

61-
| Configuration Setting | Environment Variable |
62-
| ----------------------------- | ------------------------------------- |
63-
| Enabled | NGINX_UI_LOGROTATE_ENABLED |
64-
| CMD | NGINX_UI_LOGROTATE_CMD |
65-
| Interval | NGINX_UI_LOGROTATE_INTERVAL |
63+
| Configuration Setting | Environment Variable |
64+
|-----------------------|-----------------------------|
65+
| Enabled | NGINX_UI_LOGROTATE_ENABLED |
66+
| CMD | NGINX_UI_LOGROTATE_CMD |
67+
| Interval | NGINX_UI_LOGROTATE_INTERVAL |
6668

6769
## Auth
6870

69-
| Configuration Setting | Environment Variable |
70-
|-----------------------|-----------------------------|
71-
| IPWhiteList | NGINX_UI_AUTH_IPWhiteList |
71+
| Configuration Setting | Environment Variable |
72+
|-----------------------|---------------------------|
73+
| IPWhiteList | NGINX_UI_AUTH_IPWhiteList |
7274

7375
## Webauthn
7476

@@ -78,7 +80,6 @@
7880
| RPID | NGINX_UI_WEBAUTHN_RPID |
7981
| RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS |
8082

81-
8283
## 預定義使用者
8384

8485
在跳過安裝模式下，您可以設置以下環境變量以創建預定義使用者：

‎settings/settings_test.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ func TestSetup(t *testing.T) {
3535
_ = os.Setenv("NGINX_UI_NGINX_TEST_CONFIG_CMD", "nginx -t")
3636
_ = os.Setenv("NGINX_UI_NGINX_RELOAD_CMD", "nginx -s reload")
3737
_ = os.Setenv("NGINX_UI_NGINX_RESTART_CMD", "nginx -s restart")
38+
_ = os.Setenv("NGINX_UI_NGINX_LOG_DIR_WHITE_LIST", "/var/log/nginx")
3839

3940
_ = os.Setenv("NGINX_UI_OPENAI_MODEL", "davinci")
4041
_ = os.Setenv("NGINX_UI_OPENAI_BASE_URL", "https://api.openai.com")
@@ -84,6 +85,7 @@ func TestSetup(t *testing.T) {
8485
assert.Equal(t, "nginx -t", NginxSettings.TestConfigCmd)
8586
assert.Equal(t, "nginx -s reload", NginxSettings.ReloadCmd)
8687
assert.Equal(t, "nginx -s stop", NginxSettings.RestartCmd)
88+
assert.Equal(t, []string{"/var/log/nginx"}, NginxSettings.LogDirWhiteList)
8789

8890
assert.Equal(t, "davinci", OpenAISettings.Model)
8991
assert.Equal(t, "https://api.openai.com", OpenAISettings.BaseUrl)

0 commit comments

Comments
 (0)