From 96cff98c66deba24a20fdde4c6722896f3617680 Mon Sep 17 00:00:00 2001 From: Jacky Date: Wed, 9 Oct 2024 08:51:41 +0800 Subject: [PATCH] chore: update docs --- docs/guide/env.md | 19 +++++---- docs/zh_CN/guide/env.md | 87 ++++++++++++++++++++------------------- docs/zh_TW/guide/env.md | 87 ++++++++++++++++++++------------------- settings/settings_test.go | 2 + 4 files changed, 100 insertions(+), 95 deletions(-) diff --git a/docs/guide/env.md b/docs/guide/env.md index 8d770afb..4c177270 100644 --- a/docs/guide/env.md +++ b/docs/guide/env.md @@ -26,15 +26,16 @@ Applicable for version v2.0.0-beta.23 and above. ## Nginx -| Configuration Setting | Environment Variable | -|-----------------------|--------------------------------| -| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH | -| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH | -| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR | -| PIDPath | NGINX_UI_NGINX_PID_PATH | -| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD | -| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD | -| RestartCmd | NGINX_UI_NGINX_RESTART_CMD | +| Configuration Setting | Environment Variable | +|-----------------------|-----------------------------------| +| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH | +| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH | +| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR | +| PIDPath | NGINX_UI_NGINX_PID_PATH | +| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD | +| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD | +| RestartCmd | NGINX_UI_NGINX_RESTART_CMD | +| LogDirWhiteList | NGINX_UI_NGINX_LOG_DIR_WHITE_LIST | ## OpenAI diff --git a/docs/zh_CN/guide/env.md b/docs/zh_CN/guide/env.md index 1b61594c..649aed89 100644 --- a/docs/zh_CN/guide/env.md +++ b/docs/zh_CN/guide/env.md @@ -1,48 +1,50 @@ # 环境变量 + 适用于 v2.0.0-beta.23 及以上版本 ## Server -| Configuration Setting | Environment Variable | -|-------------------------| ------------------------------------- | -| HttpPort | NGINX_UI_SERVER_HTTP_PORT | -| RunMode | NGINX_UI_SERVER_RUN_MODE | -| JwtSecret | NGINX_UI_SERVER_JWT_SECRET | -| HTTPChallengePort | NGINX_UI_SERVER_HTTP_CHALLENGE_PORT | -| StartCmd | NGINX_UI_SERVER_START_CMD | -| Database | NGINX_UI_SERVER_DATABASE | -| CADir | NGINX_UI_SERVER_CA_DIR | -| GithubProxy | NGINX_UI_SERVER_GITHUB_PROXY | -| NodeSecret | NGINX_UI_SERVER_NODE_SECRET | -| Demo | NGINX_UI_SERVER_DEMO | -| PageSize | NGINX_UI_SERVER_PAGE_SIZE | -| HttpHost | NGINX_UI_SERVER_HTTP_HOST | -| CertRenewalInterval | NGINX_UI_SERVER_CERT_RENEWAL_INTERVAL | -| RecursiveNameservers | NGINX_UI_SERVER_RECURSIVE_NAMESERVERS | -| SkipInstallation | NGINX_UI_SERVER_SKIP_INSTALLATION | -| Name | NGINX_UI_SERVER_NAME | -| InsecureSkipVerify | NGINX_UI_SERVER_INSECURE_SKIP_VERIFY | +| Configuration Setting | Environment Variable | +|-----------------------|---------------------------------------| +| HttpPort | NGINX_UI_SERVER_HTTP_PORT | +| RunMode | NGINX_UI_SERVER_RUN_MODE | +| JwtSecret | NGINX_UI_SERVER_JWT_SECRET | +| HTTPChallengePort | NGINX_UI_SERVER_HTTP_CHALLENGE_PORT | +| StartCmd | NGINX_UI_SERVER_START_CMD | +| Database | NGINX_UI_SERVER_DATABASE | +| CADir | NGINX_UI_SERVER_CA_DIR | +| GithubProxy | NGINX_UI_SERVER_GITHUB_PROXY | +| NodeSecret | NGINX_UI_SERVER_NODE_SECRET | +| Demo | NGINX_UI_SERVER_DEMO | +| PageSize | NGINX_UI_SERVER_PAGE_SIZE | +| HttpHost | NGINX_UI_SERVER_HTTP_HOST | +| CertRenewalInterval | NGINX_UI_SERVER_CERT_RENEWAL_INTERVAL | +| RecursiveNameservers | NGINX_UI_SERVER_RECURSIVE_NAMESERVERS | +| SkipInstallation | NGINX_UI_SERVER_SKIP_INSTALLATION | +| Name | NGINX_UI_SERVER_NAME | +| InsecureSkipVerify | NGINX_UI_SERVER_INSECURE_SKIP_VERIFY | ## Nginx -| Configuration Setting | Environment Variable | -| ----------------------------- | ------------------------------------- | -| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH | -| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH | -| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR | -| PIDPath | NGINX_UI_NGINX_PID_PATH | -| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD | -| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD | -| RestartCmd | NGINX_UI_NGINX_RESTART_CMD | +| Configuration Setting | Environment Variable | +|-----------------------|-----------------------------------| +| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH | +| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH | +| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR | +| PIDPath | NGINX_UI_NGINX_PID_PATH | +| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD | +| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD | +| RestartCmd | NGINX_UI_NGINX_RESTART_CMD | +| LogDirWhiteList | NGINX_UI_NGINX_LOG_DIR_WHITE_LIST | ## OpenAI -| Configuration Setting | Environment Variable | -| ----------------------------- | ------------------------------------- | -| Model | NGINX_UI_OPENAI_MODEL | -| BaseUrl | NGINX_UI_OPENAI_BASE_URL | -| Proxy | NGINX_UI_OPENAI_PROXY | -| Token | NGINX_UI_OPENAI_TOKEN | +| Configuration Setting | Environment Variable | +|-----------------------|--------------------------| +| Model | NGINX_UI_OPENAI_MODEL | +| BaseUrl | NGINX_UI_OPENAI_BASE_URL | +| Proxy | NGINX_UI_OPENAI_PROXY | +| Token | NGINX_UI_OPENAI_TOKEN | ## Casdoor @@ -58,17 +60,17 @@ ## Logrotate -| Configuration Setting | Environment Variable | -| ----------------------------- | ------------------------------------- | -| Enabled | NGINX_UI_LOGROTATE_ENABLED | -| CMD | NGINX_UI_LOGROTATE_CMD | -| Interval | NGINX_UI_LOGROTATE_INTERVAL | +| Configuration Setting | Environment Variable | +|-----------------------|-----------------------------| +| Enabled | NGINX_UI_LOGROTATE_ENABLED | +| CMD | NGINX_UI_LOGROTATE_CMD | +| Interval | NGINX_UI_LOGROTATE_INTERVAL | ## Auth -| Configuration Setting | Environment Variable | -|-----------------------|-----------------------------| -| IPWhiteList | NGINX_UI_AUTH_IPWhiteList | +| Configuration Setting | Environment Variable | +|-----------------------|---------------------------| +| IPWhiteList | NGINX_UI_AUTH_IPWhiteList | ## Webauthn @@ -78,7 +80,6 @@ | RPID | NGINX_UI_WEBAUTHN_RPID | | RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS | - ## 预定义用户 在跳过安装模式下，您可以设置以下环境变量以创建预定义用户： diff --git a/docs/zh_TW/guide/env.md b/docs/zh_TW/guide/env.md index 0bb821a7..19bd285d 100644 --- a/docs/zh_TW/guide/env.md +++ b/docs/zh_TW/guide/env.md @@ -1,48 +1,50 @@ # 環境變量 + 適用於 v2.0.0-beta.23 及以上版本 ## Server -| Configuration Setting | Environment Variable | -|------------------------| ------------------------------------- | -| HttpPort | NGINX_UI_SERVER_HTTP_PORT | -| RunMode | NGINX_UI_SERVER_RUN_MODE | -| JwtSecret | NGINX_UI_SERVER_JWT_SECRET | -| HTTPChallengePort | NGINX_UI_SERVER_HTTP_CHALLENGE_PORT | -| StartCmd | NGINX_UI_SERVER_START_CMD | -| Database | NGINX_UI_SERVER_DATABASE | -| CADir | NGINX_UI_SERVER_CA_DIR | -| GithubProxy | NGINX_UI_SERVER_GITHUB_PROXY | -| NodeSecret | NGINX_UI_SERVER_NODE_SECRET | -| Demo | NGINX_UI_SERVER_DEMO | -| PageSize | NGINX_UI_SERVER_PAGE_SIZE | -| HttpHost | NGINX_UI_SERVER_HTTP_HOST | -| CertRenewalInterval | NGINX_UI_SERVER_CERT_RENEWAL_INTERVAL | -| RecursiveNameservers | NGINX_UI_SERVER_RECURSIVE_NAMESERVERS | -| SkipInstallation | NGINX_UI_SERVER_SKIP_INSTALLATION | -| Name | NGINX_UI_SERVER_NAME | -| InsecureSkipVerify | NGINX_UI_SERVER_INSECURE_SKIP_VERIFY | +| Configuration Setting | Environment Variable | +|-----------------------|---------------------------------------| +| HttpPort | NGINX_UI_SERVER_HTTP_PORT | +| RunMode | NGINX_UI_SERVER_RUN_MODE | +| JwtSecret | NGINX_UI_SERVER_JWT_SECRET | +| HTTPChallengePort | NGINX_UI_SERVER_HTTP_CHALLENGE_PORT | +| StartCmd | NGINX_UI_SERVER_START_CMD | +| Database | NGINX_UI_SERVER_DATABASE | +| CADir | NGINX_UI_SERVER_CA_DIR | +| GithubProxy | NGINX_UI_SERVER_GITHUB_PROXY | +| NodeSecret | NGINX_UI_SERVER_NODE_SECRET | +| Demo | NGINX_UI_SERVER_DEMO | +| PageSize | NGINX_UI_SERVER_PAGE_SIZE | +| HttpHost | NGINX_UI_SERVER_HTTP_HOST | +| CertRenewalInterval | NGINX_UI_SERVER_CERT_RENEWAL_INTERVAL | +| RecursiveNameservers | NGINX_UI_SERVER_RECURSIVE_NAMESERVERS | +| SkipInstallation | NGINX_UI_SERVER_SKIP_INSTALLATION | +| Name | NGINX_UI_SERVER_NAME | +| InsecureSkipVerify | NGINX_UI_SERVER_INSECURE_SKIP_VERIFY | ## Nginx -| Configuration Setting | Environment Variable | -| ----------------------------- | ------------------------------------- | -| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH | -| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH | -| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR | -| PIDPath | NGINX_UI_NGINX_PID_PATH | -| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD | -| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD | -| RestartCmd | NGINX_UI_NGINX_RESTART_CMD | +| Configuration Setting | Environment Variable | +|-----------------------|-----------------------------------| +| AccessLogPath | NGINX_UI_NGINX_ACCESS_LOG_PATH | +| ErrorLogPath | NGINX_UI_NGINX_ERROR_LOG_PATH | +| ConfigDir | NGINX_UI_NGINX_CONFIG_DIR | +| PIDPath | NGINX_UI_NGINX_PID_PATH | +| TestConfigCmd | NGINX_UI_NGINX_TEST_CONFIG_CMD | +| ReloadCmd | NGINX_UI_NGINX_RELOAD_CMD | +| RestartCmd | NGINX_UI_NGINX_RESTART_CMD | +| LogDirWhiteList | NGINX_UI_NGINX_LOG_DIR_WHITE_LIST | ## OpenAI -| Configuration Setting | Environment Variable | -| ----------------------------- | ------------------------------------- | -| Model | NGINX_UI_OPENAI_MODEL | -| BaseUrl | NGINX_UI_OPENAI_BASE_URL | -| Proxy | NGINX_UI_OPENAI_PROXY | -| Token | NGINX_UI_OPENAI_TOKEN | +| Configuration Setting | Environment Variable | +|-----------------------|--------------------------| +| Model | NGINX_UI_OPENAI_MODEL | +| BaseUrl | NGINX_UI_OPENAI_BASE_URL | +| Proxy | NGINX_UI_OPENAI_PROXY | +| Token | NGINX_UI_OPENAI_TOKEN | ## Casdoor @@ -58,17 +60,17 @@ ## Logrotate -| Configuration Setting | Environment Variable | -| ----------------------------- | ------------------------------------- | -| Enabled | NGINX_UI_LOGROTATE_ENABLED | -| CMD | NGINX_UI_LOGROTATE_CMD | -| Interval | NGINX_UI_LOGROTATE_INTERVAL | +| Configuration Setting | Environment Variable | +|-----------------------|-----------------------------| +| Enabled | NGINX_UI_LOGROTATE_ENABLED | +| CMD | NGINX_UI_LOGROTATE_CMD | +| Interval | NGINX_UI_LOGROTATE_INTERVAL | ## Auth -| Configuration Setting | Environment Variable | -|-----------------------|-----------------------------| -| IPWhiteList | NGINX_UI_AUTH_IPWhiteList | +| Configuration Setting | Environment Variable | +|-----------------------|---------------------------| +| IPWhiteList | NGINX_UI_AUTH_IPWhiteList | ## Webauthn @@ -78,7 +80,6 @@ | RPID | NGINX_UI_WEBAUTHN_RPID | | RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS | - ## 預定義使用者 在跳過安裝模式下，您可以設置以下環境變量以創建預定義使用者： diff --git a/settings/settings_test.go b/settings/settings_test.go index 93bc367f..ccde9725 100644 --- a/settings/settings_test.go +++ b/settings/settings_test.go @@ -35,6 +35,7 @@ func TestSetup(t *testing.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_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_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 -s reload", NginxSettings.ReloadCmd) 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, "https://api.openai.com", OpenAISettings.BaseUrl)