Skip to content

Environment variables

Authoritative source: 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 everything you typically reach for.

For the install-oriented subset see /help/setup/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.

Repository

VariableDefaultPurpose
DIRIGIBLE_REPOSITORY_LOCAL_ROOT_FOLDER./target/On-disk registry root.
DIRIGIBLE_REPOSITORY_PROVIDERlocalRepository backend.
DIRIGIBLE_REPOSITORY_MASTER_PROVIDERMaster / upstream repository.
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_DEFAULTDefaultDBDefault data source name.
DIRIGIBLE_DATABASE_DATASOURCE_NAME_SYSTEMSystemDBSystem data source name.
DIRIGIBLE_LEAKED_CONNECTIONS_CHECK_INTERVAL_SECONDSJDBC leak-check cadence.
DIRIGIBLE_LEAKED_CONNECTIONS_CHECK_MAX_IN_USE_SECONDSThreshold before logging a leak.

Multi-tenancy

VariableDefaultPurpose
DIRIGIBLE_MULTI_TENANT_MODEtrueMulti-tenant switch.
DIRIGIBLE_TENANT_SUBDOMAIN_REGEXTenant resolution regex.
DIRIGIBLE_TENANTS_PROVISIONING_FREQUENCY_SECONDSProvisioning poll cadence.

Synchronizers

VariablePurpose
DIRIGIBLE_SYNCHRONIZER_FREQUENCYReconciliation cadence (seconds).
DIRIGIBLE_SYNCHRONIZER_CROSS_RETRY_COUNTRetry budget for cross-synchronizer dependencies.
DIRIGIBLE_SYNCHRONIZER_CROSS_RETRY_INTERVAL_MILLISRetry interval.

Debuggers and language tooling

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

Mail

VariablePurpose
DIRIGIBLE_MAIL_USERNAMESMTP username.
DIRIGIBLE_MAIL_PASSWORDSMTP password.
DIRIGIBLE_MAIL_TRANSPORT_PROTOCOLsmtp or smtps.
DIRIGIBLE_MAIL_SMTPS_HOST / DIRIGIBLE_MAIL_SMTP_HOSTSMTP host.
DIRIGIBLE_MAIL_SMTPS_PORT / DIRIGIBLE_MAIL_SMTP_PORTSMTP port.
DIRIGIBLE_MAIL_SMTPS_AUTH / DIRIGIBLE_MAIL_SMTP_AUTHAuth toggle.

Flowable

VariablePurpose
DIRIGIBLE_FLOWABLE_DATABASE_*Flowable's own data source.
DIRIGIBLE_FLOWABLE_MAIL_*Flowable mail settings.

CMS / S3 / SharePoint

VariablePurpose
DIRIGIBLE_CMS_INTERNAL_ROOT_FOLDERInternal CMIS root.
DIRIGIBLE_S3_PROVIDERaws or localstack.
DIRIGIBLE_MS_SHAREPOINT_*SharePoint CMS credentials.

Authentication providers

VariablePurpose
DIRIGIBLE_GITHUB_CLIENT_ID / _CLIENT_SECRET / _SCOPEGitHub OAuth (github profile).
DIRIGIBLE_KEYCLOAK_*Keycloak.
DIRIGIBLE_COGNITO_*AWS Cognito.
DIRIGIBLE_SNOWFLAKE_*Snowflake OAuth.

Encryption

VariablePurpose
DIRIGIBLE_ENCRYPTION_KEYBase64 master key.
DIRIGIBLE_ENCRYPTION_KEYSTORE_*Java keystore alternative.

Misc

VariablePurpose
DIRIGIBLE_EXEC_COMMAND_LOGGING_ENABLEDAudit shell-exec calls.
DIRIGIBLE_TRIAL_ENABLEDTrial-mode flag.
SPRING_PROFILES_ACTIVESpring profile selector (github, keycloak, cognito, snowflake, ...).

The platform reads variables only through DirigibleConfig / Configuration. New tunables are added to those classes - don't introduce ad-hoc System.getProperty reads.

See also

Released under the EPL-2.0 License.