Skip to content

Environment Variables

Applicable for version v2.0.0-beta.37 and above.

App

Configuration SettingEnvironment Variable
PageSizeNGINX_UI_APP_PAGE_SIZE
JwtSecretNGINX_UI_APP_JWT_SECRET

Server

Configuration SettingEnvironment Variable
HostNGINX_UI_SERVER_HOST
PortNGINX_UI_SERVER_PORT
RunModeNGINX_UI_SERVER_RUN_MODE

Database

Configuration SettingEnvironment Variable
NameNGINX_UI_DB_NAME

Auth

Configuration SettingEnvironment Variable
IPWhiteListNGINX_UI_AUTH_IP_WHITE_LIST
BanThresholdMinutesNGINX_UI_AUTH_BAN_THRESHOLD_MINUTES
MaxAttemptsNGINX_UI_AUTH_MAX_ATTEMPTS

Casdoor

Configuration SettingEnvironment Variable
EndpointNGINX_UI_CASDOOR_ENDPOINT
ClientIdNGINX_UI_CASDOOR_CLIENT_ID
ClientSecretNGINX_UI_CASDOOR_CLIENT_SECRET
CertificatePathNGINX_UI_CASDOOR_CERTIFICATE_PATH
OrganizationNGINX_UI_CASDOOR_ORGANIZATION
ApplicationNGINX_UI_CASDOOR_APPLICATION
RedirectUriNGINX_UI_CASDOOR_REDIRECT_URI

Cert

Configuration SettingEnvironment Variable
EmailNGINX_UI_CERT_EMAIL
CADirNGINX_UI_CERT_CA_DIR
RenewalIntervalNGINX_UI_CERT_RENEWAL_INTERVAL
RecursiveNameserversNGINX_UI_CERT_RECURSIVE_NAMESERVERS
HTTPChallengePortNGINX_UI_CERT_HTTP_CHALLENGE_PORT

Cluster

Configuration SettingEnvironment Variable
NodeNGINX_UI_CLUSTER_NODE

Crypto

Configuration SettingEnvironment Variable
SecretNGINX_UI_CRYPTO_SECRET

Http

Configuration SettingEnvironment Variable
GithubProxyNGINX_UI_HTTP_GITHUB_PROXY
InsecureSkipVerifyNGINX_UI_HTTP_INSECURE_SKIP_VERIFY

Logrotate

Configuration SettingEnvironment Variable
EnabledNGINX_UI_LOGROTATE_ENABLED
CMDNGINX_UI_LOGROTATE_CMD
IntervalNGINX_UI_LOGROTATE_INTERVAL

Nginx

Configuration SettingEnvironment Variable
AccessLogPathNGINX_UI_NGINX_ACCESS_LOG_PATH
ErrorLogPathNGINX_UI_NGINX_ERROR_LOG_PATH
ConfigDirNGINX_UI_NGINX_CONFIG_DIR
PIDPathNGINX_UI_NGINX_PID_PATH
TestConfigCmdNGINX_UI_NGINX_TEST_CONFIG_CMD
ReloadCmdNGINX_UI_NGINX_RELOAD_CMD
RestartCmdNGINX_UI_NGINX_RESTART_CMD
LogDirWhiteListNGINX_UI_NGINX_LOG_DIR_WHITE_LIST

Node

Configuration SettingEnvironment Variable
NameNGINX_UI_NODE_NAME
SecretNGINX_UI_NODE_SECRET
SkipInstallationNGINX_UI_NODE_SKIP_INSTALLATION

OpenAI

Configuration SettingEnvironment Variable
ModelNGINX_UI_OPENAI_MODEL
BaseUrlNGINX_UI_OPENAI_BASE_URL
ProxyNGINX_UI_OPENAI_PROXY
TokenNGINX_UI_OPENAI_TOKEN

Terminal

Configuration SettingEnvironment Variable
StartCmdNGINX_UI_TERMINAL_START_CMD

Webauthn

Configuration SettingEnvironment Variable
RPDisplayNameNGINX_UI_WEBAUTHN_RP_DISPLAY_NAME
RPIDNGINX_UI_WEBAUTHN_RPID
RPOriginsNGINX_UI_WEBAUTHN_RP_ORIGINS

Predefined User

In skip installation mode, you can set the following environment variables to create a predefined user:

  • NGINX_UI_PREDEFINED_USER_NAME
  • NGINX_UI_PREDEFINED_USER_PASSWORD

Released under the AGPL-3.0 License. (835349c3)