mirror of
https://github.com/0xJacky/nginx-ui.git
synced 2026-09-03 07:24:52 +08:00
7.6 KiB
7.6 KiB
环境变量
适用于 v2.0.0-beta.37 及以上版本。
App
| 配置 | 环境变量 |
|---|---|
| PageSize | NGINX_UI_APP_PAGE_SIZE |
| JwtSecret | NGINX_UI_APP_JWT_SECRET |
Server
| 配置 | 环境变量 |
|---|---|
| Host | NGINX_UI_SERVER_HOST |
| Port | NGINX_UI_SERVER_PORT |
| RunMode | NGINX_UI_SERVER_RUN_MODE |
| EnableHTTPS | NGINX_UI_SERVER_ENABLE_HTTPS |
| EnableH2 | NGINX_UI_SERVER_ENABLE_H2 |
| EnableH3 | NGINX_UI_SERVER_ENABLE_H3 |
Database
| 配置 | 环境变量 |
|---|---|
| Name | NGINX_UI_DB_NAME |
Auth
| 配置 | 环境变量 |
|---|---|
| IPWhiteList | NGINX_UI_AUTH_IP_WHITE_LIST |
| BanThresholdMinutes | NGINX_UI_AUTH_BAN_THRESHOLD_MINUTES |
| MaxAttempts | NGINX_UI_AUTH_MAX_ATTEMPTS |
Casdoor
| 配置 | 环境变量 |
|---|---|
| Endpoint | NGINX_UI_CASDOOR_ENDPOINT |
| ClientId | NGINX_UI_CASDOOR_CLIENT_ID |
| ClientSecret | NGINX_UI_CASDOOR_CLIENT_SECRET |
| CertificatePath | NGINX_UI_CASDOOR_CERTIFICATE_PATH |
| Organization | NGINX_UI_CASDOOR_ORGANIZATION |
| Application | NGINX_UI_CASDOOR_APPLICATION |
| RedirectUri | NGINX_UI_CASDOOR_REDIRECT_URI |
Oidc
| 配置 | 环境变量 |
|---|---|
| Endpoint | NGINX_UI_OIDC_ENDPOINT |
| ClientId | NGINX_UI_OIDC_CLIENT_ID |
| ClientSecret | NGINX_UI_OIDC_CLIENT_SECRET |
| RedirectUri | NGINX_UI_OIDC_REDIRECT_URI |
| Scopes | NGINX_UI_OIDC_SCOPES |
| Identifier | NGINX_UI_OIDC_IDENTIFIER |
Cert
| 配置 | 环境变量 |
|---|---|
| NGINX_UI_CERT_EMAIL | |
| CADir | NGINX_UI_CERT_CA_DIR |
| RenewalInterval | NGINX_UI_CERT_RENEWAL_INTERVAL |
| RecursiveNameservers | NGINX_UI_CERT_RECURSIVE_NAMESERVERS |
| HTTPChallengePort | NGINX_UI_CERT_HTTP_CHALLENGE_PORT |
Cluster
| 配置 | 环境变量 |
|---|---|
| Node | NGINX_UI_CLUSTER_NODE |
Crypto
| 配置 | 环境变量 |
|---|---|
| Secret | NGINX_UI_CRYPTO_SECRET |
Http
| 配置 | 环境变量 |
|---|---|
| GithubProxy | NGINX_UI_HTTP_GITHUB_PROXY |
| HTTPProxy | NGINX_UI_HTTP_HTTP_PROXY |
| InsecureSkipVerify | NGINX_UI_HTTP_INSECURE_SKIP_VERIFY |
| WebSocketTrustedOrigins | NGINX_UI_HTTP_WEBSOCKET_TRUSTED_ORIGINS |
Logrotate
| 配置 | 环境变量 |
|---|---|
| Enabled | NGINX_UI_LOGROTATE_ENABLED |
| CMD | NGINX_UI_LOGROTATE_CMD |
| Interval | NGINX_UI_LOGROTATE_INTERVAL |
Nginx
| 配置 | 环境变量 |
|---|---|
| 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 |
| SbinPath | NGINX_UI_NGINX_SBIN_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 |
| StubStatusPort | NGINX_UI_NGINX_STUB_STATUS_PORT |
| ContainerName | NGINX_UI_NGINX_CONTAINER_NAME |
| MaintenanceDir | NGINX_UI_NGINX_MAINTENANCE_DIR |
| MaintenanceTemplate | NGINX_UI_NGINX_MAINTENANCE_TEMPLATE |
Nginx Log
| 配置 | 环境变量 |
|---|---|
| IndexingEnabled | NGINX_UI_NGINX_LOG_INDEXING_ENABLED |
| IndexPath | NGINX_UI_NGINX_LOG_INDEX_PATH |
Node
| 配置 | 环境变量 |
|---|---|
| Name | NGINX_UI_NODE_NAME |
| Secret | NGINX_UI_NODE_SECRET |
| SkipInstallation | NGINX_UI_NODE_SKIP_INSTALLATION |
OpenAI
| 配置 | 环境变量 |
|---|---|
| Model | NGINX_UI_OPENAI_MODEL |
| BaseUrl | NGINX_UI_OPENAI_BASE_URL |
| Proxy | NGINX_UI_OPENAI_PROXY |
| Token | NGINX_UI_OPENAI_TOKEN |
Terminal
| 配置 | 环境变量 |
|---|---|
| StartCmd | NGINX_UI_TERMINAL_START_CMD |
Webauthn
| 配置 | 环境变量 |
|---|---|
| RPDisplayName | NGINX_UI_WEBAUTHN_RP_DISPLAY_NAME |
| RPID | NGINX_UI_WEBAUTHN_RPID |
| RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS |
预定义用户
在跳过安装模式下，您可以设置以下环境变量以创建预定义用户：
- NGINX_UI_PREDEFINED_USER_NAME
- NGINX_UI_PREDEFINED_USER_PASSWORD
通过 SSH 控制宿主机
::: info 这些变量用于 Nginx UI 在 Docker 容器中通过 SSH 控制宿主机上原生安装的 nginx 服务。 :::
| 变量 | 描述 |
|---|---|
NGINX_UI_NGINX_HOST_MODE |
设置为 ssh 以启用宿主机 SSH 控制 |
NGINX_UI_NGINX_HOST_ACCESS_MODE |
sftp 或 mounted。SSH 模式下必填：容器通过 SFTP 还是通过 bind mount 访问宿主机 nginx 文件 |
NGINX_UI_NGINX_HOST_KEY_SOURCE |
generated（默认）、existing 或 provided：SSH 私钥的来源 |
NGINX_UI_NGINX_HOST_ADDRESS |
远程 host:port，例如 host.docker.internal:22 |
NGINX_UI_NGINX_HOST_USER |
宿主机上的 SSH 用户 |
NGINX_UI_NGINX_HOST_AUTH_METHOD |
SSH 认证方式。当前宿主机 SSH 配置请使用密钥认证 |
NGINX_UI_NGINX_HOST_PRIVATE_KEY_PATH |
容器内的私钥路径 |
NGINX_UI_NGINX_HOST_KNOWN_HOSTS_PATH |
容器内的 known_hosts 允许列表路径 |
NGINX_UI_NGINX_HOST_SUDO_PREFIX |
默认为 sudo -n |
NGINX_UI_NGINX_HOST_SERVICE_MANAGER |
systemd（默认）或 launchd |
NGINX_UI_NGINX_HOST_SYSTEMD_UNIT_NAME |
默认为 nginx.service |
NGINX_UI_NGINX_HOST_SYSTEMCTL_PATH |
宿主机上 systemctl 的绝对路径 |
NGINX_UI_NGINX_HOST_LAUNCHD_SERVICE |
launchd 标签，默认为 homebrew.mxcl.nginx |
NGINX_UI_NGINX_HOST_LAUNCHCTL_PATH |
launchctl 的绝对路径，默认为 /bin/launchctl |
NGINX_UI_NGINX_HOST_CONFIG_DIR |
宿主机侧的 nginx 配置目录 |
NGINX_UI_NGINX_HOST_LOG_DIR |
宿主机侧的 nginx 日志目录 |
NGINX_UI_NGINX_SBIN_PATH |
SSH 模式下可选：宿主机上 nginx 可执行文件的绝对路径。留空时，Nginx UI 会解析服务管理器的默认值（systemd 为 /usr/sbin/nginx，launchd 为 /opt/homebrew/opt/nginx/bin/nginx）。生成的 sudoers 允许列表会精确匹配解析后的路径 |
NGINX_UI_DISABLE_BUNDLED_NGINX |
设置为 true 以禁用容器内置的 nginx（SSH 模式下必需） |