Skip to content

Commit 392cac4

Browse files
0xJacky0xJacky
committed
chore(docs): add env reference
1 parent c18f8f0 commit 392cac4

File tree

10 files changed

+238
-4
lines changed

10 files changed

+238
-4
lines changed

‎docs/.vitepress/config/en.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ export const enConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
4242
{text: 'Cluster', link: '/guide/config-cluster'}
4343
]
4444
},
45+
{
46+
text: 'Environment Variables',
47+
collapsed: false,
48+
items: [
49+
{text: 'Reference', link: '/guide/env'},
50+
]
51+
},
4552
{
4653
text: 'Appendix',
4754
collapsed: false,

‎docs/.vitepress/config/zh_CN.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,13 @@ export const zhCNConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
4747
{text: '集群', link: '/zh_CN/guide/config-cluster'}
4848
]
4949
},
50+
{
51+
text: '环境变量',
52+
collapsed: false,
53+
items: [
54+
{text: '参考手册', link: '/zh_CN/guide/env'},
55+
]
56+
},
5057
{
5158
text: '附录',
5259
collapsed: false,

‎docs/.vitepress/config/zh_TW.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,13 @@ export const zhTWConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
4646
{text: '集群', link: '/zh_TW/guide/config-cluster'}
4747
]
4848
},
49+
{
50+
text: '環境變量',
51+
collapsed: false,
52+
items: [
53+
{text: '參考手冊', link: '/zh_TW/guide/env'},
54+
]
55+
},
4956
{
5057
text: '附錄',
5158
collapsed: false,

‎docs/guide/build.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Regular users should follow the [quick start](./getting-started) guide.
66
## Prerequisites
77

88
- Make.
9-
- Golang version 1.21 or higher.
9+
- Golang version 1.22 or higher.
1010
- node.js version 21 or higher.
1111

1212
You should execute the following command to update browser list database before build project.

‎docs/guide/config-cluster.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 集群
1+
# Cluster
22
From v2.0.0-beta.23, you can define multiple environments in the `cluster` section of the configuration file.
33

44
## Node

‎docs/guide/env.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Environment Variables
2+
Applicable for version v2.0.0-beta.23 and above.
3+
4+
## Server
5+
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+
25+
## Nginx
26+
27+
| Configuration Setting | Environment Variable |
28+
| ----------------------------- | ------------------------------------- |
29+
| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH |
30+
| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH |
31+
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
32+
| PIDPath | NGINX_UI_NGINX_PID_PATH |
33+
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
34+
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
35+
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
36+
37+
## OpenAI
38+
39+
| Configuration Setting | Environment Variable |
40+
| ----------------------------- | ------------------------------------- |
41+
| Model | NGINX_UI_OPENAI_MODEL |
42+
| BaseUrl | NGINX_UI_OPENAI_BASE_URL |
43+
| Proxy | NGINX_UI_OPENAI_PROXY |
44+
| Token | NGINX_UI_OPENAI_TOKEN |
45+
46+
## Casdoor
47+
48+
| Configuration Setting | Environment Variable |
49+
| ----------------------------- | ------------------------------------- |
50+
| Endpoint | NGINX_UI_CASDOOR_ENDPOINT |
51+
| ClientId | NGINX_UI_CASDOOR_CLIENT_ID |
52+
| ClientSecret | NGINX_UI_CASDOOR_CLIENT_SECRET |
53+
| Certificate | NGINX_UI_CASDOOR_CERTIFICATE |
54+
| Organization | NGINX_UI_CASDOOR_ORGANIZATION |
55+
| Application | NGINX_UI_CASDOOR_APPLICATION |
56+
| RedirectUri | NGINX_UI_CASDOOR_REDIRECT_URI |
57+
58+
## Logrotate
59+
60+
| Configuration Setting | Environment Variable |
61+
| ----------------------------- | ------------------------------------- |
62+
| Enabled | NGINX_UI_LOGROTATE_ENABLED |
63+
| CMD | NGINX_UI_LOGROTATE_CMD |
64+
| Interval | NGINX_UI_LOGROTATE_INTERVAL |
65+
66+
## Predefined User
67+
68+
In skip installation mode, you can set the following environment variables to create a predefined user:
69+
70+
- NGINX_UI_PREDEFINED_USER_NAME
71+
- NGINX_UI_PREDEFINED_USER_PASSWORD

‎docs/zh_CN/guide/build.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
## 依赖
66

77
- Make
8-
- Golang 版本 1.21 或更高
8+
- Golang 版本 1.22 或更高
99
- node.js 版本 21 或更高
1010

1111
你需要在构建项目之前执行以下命令更新浏览器列表数据库。

‎docs/zh_CN/guide/env.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# 环境变量
2+
适用于 v2.0.0-beta.23 及以上版本
3+
4+
## 服务器
5+
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+
25+
## Nginx
26+
27+
| Configuration Setting | Environment Variable |
28+
| ----------------------------- | ------------------------------------- |
29+
| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH |
30+
| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH |
31+
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
32+
| PIDPath | NGINX_UI_NGINX_PID_PATH |
33+
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
34+
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
35+
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
36+
37+
## OpenAI
38+
39+
| Configuration Setting | Environment Variable |
40+
| ----------------------------- | ------------------------------------- |
41+
| Model | NGINX_UI_OPENAI_MODEL |
42+
| BaseUrl | NGINX_UI_OPENAI_BASE_URL |
43+
| Proxy | NGINX_UI_OPENAI_PROXY |
44+
| Token | NGINX_UI_OPENAI_TOKEN |
45+
46+
## Casdoor
47+
48+
| Configuration Setting | Environment Variable |
49+
| ----------------------------- | ------------------------------------- |
50+
| Endpoint | NGINX_UI_CASDOOR_ENDPOINT |
51+
| ClientId | NGINX_UI_CASDOOR_CLIENT_ID |
52+
| ClientSecret | NGINX_UI_CASDOOR_CLIENT_SECRET |
53+
| Certificate | NGINX_UI_CASDOOR_CERTIFICATE |
54+
| Organization | NGINX_UI_CASDOOR_ORGANIZATION |
55+
| Application | NGINX_UI_CASDOOR_APPLICATION |
56+
| RedirectUri | NGINX_UI_CASDOOR_REDIRECT_URI |
57+
58+
## Logrotate
59+
60+
| Configuration Setting | Environment Variable |
61+
| ----------------------------- | ------------------------------------- |
62+
| Enabled | NGINX_UI_LOGROTATE_ENABLED |
63+
| CMD | NGINX_UI_LOGROTATE_CMD |
64+
| Interval | NGINX_UI_LOGROTATE_INTERVAL |
65+
66+
## 预定义用户
67+
68+
在跳过安装模式下，您可以设置以下环境变量以创建预定义用户：
69+
70+
- NGINX_UI_PREDEFINED_USER_NAME
71+
- NGINX_UI_PREDEFINED_USER_PASSWORD

‎docs/zh_TW/guide/build.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
## 依賴
66

77
- Make
8-
- Golang 版本 1.21 或更高
8+
- Golang 版本 1.22 或更高
99
- node.js 版本 21 或更高
1010

1111
你需要在構建專案之前執行以下命令更新瀏覽器列表資料庫。

‎docs/zh_TW/guide/env.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# 環境變量
2+
適用於 v2.0.0-beta.23 及以上版本
3+
4+
## 伺服器
5+
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+
25+
## Nginx
26+
27+
| Configuration Setting | Environment Variable |
28+
| ----------------------------- | ------------------------------------- |
29+
| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH |
30+
| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH |
31+
| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR |
32+
| PIDPath | NGINX_UI_NGINX_PID_PATH |
33+
| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD |
34+
| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD |
35+
| RestartCmd | NGINX_UI_NGINX_RESTART_CMD |
36+
37+
## OpenAI
38+
39+
| Configuration Setting | Environment Variable |
40+
| ----------------------------- | ------------------------------------- |
41+
| Model | NGINX_UI_OPENAI_MODEL |
42+
| BaseUrl | NGINX_UI_OPENAI_BASE_URL |
43+
| Proxy | NGINX_UI_OPENAI_PROXY |
44+
| Token | NGINX_UI_OPENAI_TOKEN |
45+
46+
## Casdoor
47+
48+
| Configuration Setting | Environment Variable |
49+
| ----------------------------- | ------------------------------------- |
50+
| Endpoint | NGINX_UI_CASDOOR_ENDPOINT |
51+
| ClientId | NGINX_UI_CASDOOR_CLIENT_ID |
52+
| ClientSecret | NGINX_UI_CASDOOR_CLIENT_SECRET |
53+
| Certificate | NGINX_UI_CASDOOR_CERTIFICATE |
54+
| Organization | NGINX_UI_CASDOOR_ORGANIZATION |
55+
| Application | NGINX_UI_CASDOOR_APPLICATION |
56+
| RedirectUri | NGINX_UI_CASDOOR_REDIRECT_URI |
57+
58+
## Logrotate
59+
60+
| Configuration Setting | Environment Variable |
61+
| ----------------------------- | ------------------------------------- |
62+
| Enabled | NGINX_UI_LOGROTATE_ENABLED |
63+
| CMD | NGINX_UI_LOGROTATE_CMD |
64+
| Interval | NGINX_UI_LOGROTATE_INTERVAL |
65+
66+
## 預定義使用者
67+
68+
在跳過安裝模式下，您可以設置以下環境變量以創建預定義使用者：
69+
70+
- NGINX_UI_PREDEFINED_USER_NAME
71+
- NGINX_UI_PREDEFINED_USER_PASSWORD

0 commit comments

Comments
 (0)