Skip to content

Environment variables

The authoritative source is modules/commons/commons-config/src/main/java/org/eclipse/dirigible/commons/config/DirigibleConfig.java (the enum) plus Configuration.java (the allow-list). The list below covers the variables you typically set during install.

The full reference (every variable, every default) is at /help/reference/environment-variables.

Server

VariableDefaultPurpose
DIRIGIBLE_SERVER_PORT8080HTTP listen port.
DIRIGIBLE_HOME_URLservices/web/shell-ide/Where / redirects to.
DIRIGIBLE_BASIC_USERNAMEadminDefault basic-auth user.
DIRIGIBLE_BASIC_PASSWORDadminDefault basic-auth password.
DIRIGIBLE_SECURITY_LOGIN_PAGE-Application-owned login page for the OAuth2 profiles; unauthenticated browsers are redirected there instead of the identity provider. See First-Party Sign-In.

Repository

VariableDefaultPurpose
DIRIGIBLE_REPOSITORY_LOCAL_ROOT_FOLDER./target/On-disk registry root.
DIRIGIBLE_REGISTRY_EXTERNAL_FOLDERMount an external folder into the registry.
DIRIGIBLE_REGISTRY_EXTERNAL_FOLDER_AS_SUBFOLDERMount under a sub-path.
DIRIGIBLE_REGISTRY_EXTERNAL_FOLDER_IGNORED_FOLDERSComma-separated ignore list.

Data sources

VariableDefaultPurpose
DIRIGIBLE_DATASOURCE_DEFAULT_DRIVERH2 file driverJDBC driver class.
DIRIGIBLE_DATASOURCE_DEFAULT_URLlocal H2JDBC URL.
DIRIGIBLE_DATASOURCE_DEFAULT_USERNAMEJDBC user.
DIRIGIBLE_DATASOURCE_DEFAULT_PASSWORDJDBC password.
DIRIGIBLE_DATABASE_DATASOURCE_NAME_DEFAULTDefaultDBLogical name.
DIRIGIBLE_DATABASE_DATASOURCE_NAME_SYSTEMSystemDBLogical name of the system DB.
DIRIGIBLE_LEAKED_CONNECTIONS_CHECK_INTERVAL_SECONDSJDBC leak detection cadence.
DIRIGIBLE_LEAKED_CONNECTIONS_CHECK_MAX_IN_USE_SECONDSThreshold before logging a leak.

Multi-tenancy

VariableDefaultPurpose
DIRIGIBLE_MULTI_TENANT_MODEtrueMulti-tenant switch.
DIRIGIBLE_TENANT_RESOLUTION_STRATEGYSUBDOMAINHow a request's tenant is determined: SUBDOMAIN (a host per tenant) or TOKEN_GROUPS (one host, the tenant the signed-in user selected).
DIRIGIBLE_TENANT_SUBDOMAIN_REGEXHost pattern the tenant subdomain is captured from, under the SUBDOMAIN strategy.
DIRIGIBLE_APP_IDThis deployment's application id in the group names <tenantId>.<appId>.<role>. Required under TOKEN_GROUPS, and it must not contain a dot.
DIRIGIBLE_TENANT_GROUPS_CLAIMcognito:groupsThe token claim the user's groups are read from. Set it explicitly on Keycloak.
DIRIGIBLE_TENANTS_PROVISIONING_FREQUENCY_SECONDS900Provisioning poll cadence, in seconds.
DIRIGIBLE_TENANT_PROVISIONING_API_ENABLEDfalseExposes the tenant provisioning API, through which an external service provisions tenants into this deployment. Off means absent, not closed.

See Tenant resolution and Tenant provisioning API.

Debuggers

VariableDefaultPurpose
DIRIGIBLE_JAVASCRIPT_GRAALVM_DEBUGGER_PORT8081Graalium JS debugger port.
DIRIGIBLE_GRAALIUM_ENABLE_DEBUGtrue (in Docker)Toggle JS debug.
DIRIGIBLE_JAVA_DEBUG_JDWP_PORT8000JDWP port for the Java debugger view.
DIRIGIBLE_JAVA_LSP_ENABLEDToggle JDT.LS.
DIRIGIBLE_JAVA_LSP_INSTALL_DIRJDT.LS install directory.

Synchronizers

VariableDefaultPurpose
DIRIGIBLE_SYNCHRONIZER_FREQUENCYReconciliation cadence.
DIRIGIBLE_SYNCHRONIZER_CROSS_RETRY_COUNTRetry budget for cross-synchronizer dependencies.
DIRIGIBLE_SYNCHRONIZER_CROSS_RETRY_INTERVAL_MILLISRetry interval.

Messaging

VariableDefaultPurpose
DIRIGIBLE_MESSAGING_BROKER_URLExternal ActiveMQ broker to use instead of the embedded one, e.g. tcp://activemq:61616. Unset keeps the embedded broker.
DIRIGIBLE_MESSAGING_BROKER_USERNAMEBroker username. Unset connects anonymously.
DIRIGIBLE_MESSAGING_BROKER_PASSWORDBroker password.
DIRIGIBLE_MESSAGING_USE_DEFAULT_DATABASEtruePersist the embedded broker's messages in the system database. Ignored with an external broker.

Point several nodes or deployments at one broker to share destinations between them. The broker has to be reachable when the server starts, and the Messaging perspective works only against the embedded broker. See Message listeners.

Mail / Flowable / SharePoint / S3

VariablePurpose
DIRIGIBLE_MAIL_*SMTP defaults for the Mail SDK.
DIRIGIBLE_FLOWABLE_*Flowable engine config (datasource, mail).
DIRIGIBLE_MS_SHAREPOINT_*SharePoint CMS credentials.
DIRIGIBLE_CMS_INTERNAL_ROOT_FOLDERInternal CMIS root path.
DIRIGIBLE_S3_PROVIDERaws or localstack.

OAuth (GitHub profile)

VariablePurpose
DIRIGIBLE_GITHUB_CLIENT_IDGitHub OAuth client id.
DIRIGIBLE_GITHUB_CLIENT_SECRETGitHub OAuth client secret.
DIRIGIBLE_GITHUB_SCOPERequested scopes.

Activated only when the github Spring profile is active. See /help/setup/authentication/github-oauth.

Misc

VariablePurpose
DIRIGIBLE_EXEC_COMMAND_LOGGING_ENABLEDAudit shell-exec calls.
DIRIGIBLE_TRIAL_ENABLEDTrial-mode flag.

See also

Released under the EPL-2.0 License.