Environment Variables

Configuration Types

Based on the layer, they are defined, configuration variables have the following priorities:

RuntimeEnvironmentDeploymentModule

Highest precedence:

No rebuild or restart of the application is required when configuration is changed.
The Configuration API could be used to apply changes in the Runtime configuration.

Second precedence:

No rebuild is required when configuration is changed, however the application should be restarted, to apply the environment changes.
Usually the Environment configurations are provided during the application deployment, as part of application descriptor (e.g. Define environment variable for container in Kubernetes or in Cloud Foundry App Manifest).

Third precedence:

Rebuild and re-deployment is required.
"Default" deployment (ROOT.war) configuration variables are taken from dirigible.properties properties file (sample could be found here).

Lowest precedence:

Rebuild and re-deployment is required.
"Default" module (e.g. dirigible-database-custom.jar, dirigible-database-h2.jar) configuration variables are taken from dirigible-xxx.properties properties files (sample could be found here and here)

Note

The precedence order means that, if the there is an Environment variable with name DIRIGIBLE_TEST and Runtime variable with the same name, the Runtime variable will have high prority and will be applied.

All applied configuration values could be found under the Configurations View.

Configuration Parameters

Anonymous Access

Parameter	Description	Default*
DIRIGIBLE_ANONYMOUS_USER_NAME_PROPERTY_NAME	The name of the property, that will be used to retrieve the anonymous user name (e.g. MY_USER_VARIABLE)	`-`

Branding

Parameter	Description	Default*
DIRIGIBLE_BRANDING_NAME	The brand name	`Eclipse Dirigible`
DIRIGIBLE_BRANDING_BRAND	The branding name	`Eclipse Dirigible`
DIRIGIBLE_BRANDING_BRAND_URL	The branding URL	`https://www.dirigible.io`
DIRIGIBLE_BRANDING_ICON	The branding icon	`../../../../services/v4/web/resources/images/favicon.png`
DIRIGIBLE_BRANDING_WELCOME_PAGE_DEFAULT	The branding welcome page	`../../../../services/v4/web/ide/welcome.html`
DIRIGIBLE_BRANDING_HELP_ITEMS	The list of the custom help menu items (comma separated)	`-`

Branding - Help Items

Note

Replace CUSTOM_ITEM with the actual name set by DIRIGIBLE_BRANDING_HELP_ITEMS e.g. ITEM1

Parameter	Description	Default*
DIRIGIBLE_BRANDING_HELP_ITEM_CUSTOM_ITEM_NAME	The name of the custom help item	`-`
DIRIGIBLE_BRANDING_HELP_ITEM_CUSTOM_ITEM_URL	The url of the custom help item	`-`
DIRIGIBLE_BRANDING_HELP_ITEM_CUSTOM_ITEM_ORDER	(Optional) The order of the custom help item	`0`
DIRIGIBLE_BRANDING_HELP_ITEM_CUSTOM_ITEM_DIVIDER	(Optional) Whether to set divider after the custom help item	`false`

OAuth

Parameter	Description	Default*
DIRIGIBLE_OAUTH_AUTHORIZE_URL	The OAuth authorization URL (e.g. `https://my-oauth-server/oauth/authorize`)	`-`
DIRIGIBLE_OAUTH_TOKEN_URL	The OAuth token URL (e.g. `https://my-oauth-server/oauth/token`)	`-`
DIRIGIBLE_OAUTH_CLIENT_ID	The OAuth `clientid` (e.g. `sb-xxx-yyy`)	`-`
DIRIGIBLE_OAUTH_CLIENT_SECRET	The OAuth `clientsecret` (e.g. `PID/cpkD8aZzbGaa6+muYYOOMWPDeM1ug/sQ5ZF...`)	`-`
DIRIGIBLE_OAUTH_VERIFICATION_KEY	The OAuth `verificationkey` (e.g. `-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhki...`)	`-`
DIRIGIBLE_OAUTH_APPLICATION_NAME	The application name (e.g. `dirigible-xxx`)	`-`
DIRIGIBLE_OAUTH_APPLICATION_HOST	The application host (e.g. `https://my-application-host`)	`-`
DIRIGIBLE_OAUTH_ISSUER	The OAuth `issuer` (e.g. `http://xxx.localhost:8080/uaa/oauth/token`)	`-`
DIRIGIBLE_OAUTH_CHECK_ISSUER_ENABLED	Sets whether the JWT verifier should check the token `issuer`	`true`

Git

Parameter	Description	Default*
DIRIGIBLE_GIT_ROOT_FOLDER	The external folder that will be used for synchronizing git projects	`-`

Registry

Parameter	Description	Default*
DIRIGIBLE_REGISTRY_EXTERNAL_FOLDER	The external folder that will be used for synchronizing the public registry	`-`
DIRIGIBLE_REGISTRY_IMPORT_WORKSPACE	The external folder that will be imported into the public registry	`-`

Repository

Parameter	Description	Default*
DIRIGIBLE_REPOSITORY_PROVIDER	The name of the repository provider used in this instance	`local` or `database`
DIRIGIBLE_REPOSITORY_CACHE_ENABLED	Enable the usage of the repository cache	`true`

Database Repository

Parameter	Description	Default*
DIRIGIBLE_REPOSITORY_DATABASE_DATASOURCE_NAME	The name of the data source, which will be used to store the repository artifacts	`DefaultDB`

Local Repository

Parameter	Description	Default*
DIRIGIBLE_REPOSITORY_LOCAL_ROOT_FOLDER	The location of the root folder where the repository artifacts will be stored	`.`
DIRIGIBLE_REPOSITORY_LOCAL_ROOT_FOLDER_IS_ABSOLUTE	Whether the location of the root folder is absolute or context dependent	`false`

Master Repository

Parameter	Description	Default*
DIRIGIBLE_MASTER_REPOSITORY_PROVIDER	The name of the master repository provider used in this instance (`filesystem`, `zip` or `jar`)	`-`
DIRIGIBLE_MASTER_REPOSITORY_ROOT_FOLDER	The location of the root folder where the master repository artifacts will be loaded from	`.`
DIRIGIBLE_MASTER_REPOSITORY_ZIP_LOCATION	The location of the zip file where the master repository artifacts will be loaded from (e.g. `/User/data/my-repo.zip`)	`-`
DIRIGIBLE_MASTER_REPOSITORY_JAR_PATH	The JAR path location of the zip file where the master repository artifacts will be loaded from (e.g. `/org/dirigible/example/my-repo.zip`)	`-`

Note

The JAR path is absolute inside the class path

Repository Search

Parameter	Description	Default*
DIRIGIBLE_REPOSITORY_SEARCH_ROOT_FOLDER	The location of the root folder to be used by the indexing engine	`.`
DIRIGIBLE_REPOSITORY_SEARCH_ROOT_FOLDER_IS_ABSOLUTE	Whether the location of the root folder is absolute or context dependent	`false`
DIRIGIBLE_REPOSITORY_SEARCH_INDEX_LOCATION	The sub-folder under the root folder where the index files will be stored	`dirigible/repository/index`

Database

Parameter	Description	Default*
DIRIGIBLE_DATABASE_PROVIDER	The name of the database provider which will be used in this instance (`local`, `managed` or `custom`)	`local`
DIRIGIBLE_DATABASE_DEFAULT_SET_AUTO_COMMIT	The `AUTO_COMMIT` data source parameter	`true`
DIRIGIBLE_DATABASE_DEFAULT_MAX_CONNECTIONS_COUNT	The `MAX_CONNECTIONS_COUNT` data source parameter	`8`
DIRIGIBLE_DATABASE_DEFAULT_WAIT_TIMEOUT	The `WAIT_TIMEOUT` data source parameter	`500`
DIRIGIBLE_DATABASE_DEFAULT_WAIT_COUNT	The `WAIT_COUNT` data source parameter	`5`
DIRIGIBLE_DATABASE_CUSTOM_DATASOURCES	The list of the custom data sources names used in this instance
DIRIGIBLE_DATABASE_DATASOURCE_NAME_DEFAULT	The name of the primary data source used in this instance	`DefaultDB`
DIRIGIBLE_DATABASE_DATASOURCE_NAME_SYSTEM	The name of the system data source used in this instance	`SystemDB`
DIRIGIBLE_DATABASE_NAMES_CASE_SENSITIVE	The names of the tables, views and columns to be considered as case sensitive	`false`

Database - Custom

Note

Replace CUSTOM_NAME with the actual name set by DIRIGIBLE_DATABASE_CUSTOM_DATASOURCES e.g. POSTGRES_DRIVER

Parameter	Description	Default*
CUSTOM_NAME_DRIVER	The `Driver` name of the custom datasource (e.g. `org.postgresql.Driver`)	`-`
CUSTOM_NAME_URL	The `URL` of the custom datasource (e.g. `jdbc:postgresql://localhost:5432/<database-name>`)	`-`
CUSTOM_NAME_USERNAME	The `User Name` of the custom datasource	`-`
CUSTOM_NAME_PASSWORD	The `Password` of the custom datasource	`-`
CUSTOM_NAME_CONNECTION_PROPERTIES	The additional connection properties if any	-

Database Derby

Parameter	Description	Default*
DIRIGIBLE_DATABASE_DERBY_ROOT_FOLDER_DEFAULT	The location used by Derby database	`./target/dirigible/derby`

Database H2

Parameter	Description	Default*
DIRIGIBLE_DATABASE_H2_ROOT_FOLDER_DEFAULT	The location used by H2 database	`./target/dirigible/h2`
DIRIGIBLE_DATABASE_H2_DRIVER	The Driver used by H2 database	`org.h2.Driver`
DIRIGIBLE_DATABASE_H2_URL	The URL used by H2 database	`jdbc:h2:./target/dirigible/h2`
DIRIGIBLE_DATABASE_H2_USERNAME	The Username used by H2 database	`sa`
DIRIGIBLE_DATABASE_H2_PASSWORD	The Password used by H2 database	`-`

Persistence

Parameter	Description	Default*
DIRIGIBLE_PERSISTENCE_CREATE_TABLE_ON_USE	Whether the table to be created automatically on use if it does not exist	`true`

MongoDB

Parameter	Description	Default*
DIRIGIBLE_MONGODB_CLIENT_URI	The location used by MongoDB server	`mongodb://localhost:27017`
DIRIGIBLE_MONGODB_DATABASE_DEFAULT	The default database name	`db`

Scheduler

Parameter	Description	Default*
DIRIGIBLE_SCHEDULER_MEMORY_STORE	Whether Quartz to use in-memory job store	`false`
DIRIGIBLE_SCHEDULER_DATABASE_DATASOURCE_TYPE	The type of the custom data-source used by Quartz, if not the default one	`-`
DIRIGIBLE_SCHEDULER_DATABASE_DATASOURCE_NAME	The name of the custom data-source used by Quartz, if not the default one	`-`
DIRIGIBLE_SCHEDULER_DATABASE_DELEGATE	The name of the JDBC delegate used by Quartz, if not the default one	`org.quartz.impl.jdbcjobstore.StdJDBCDelegate`

org.quartz.impl.jdbcjobstore.StdJDBCDelegate (for fully JDBC-compliant drivers)
org.quartz.impl.jdbcjobstore.MSSQLDelegate (for Microsoft SQL Server, and Sybase)
org.quartz.impl.jdbcjobstore.PostgreSQLDelegate
org.quartz.impl.jdbcjobstore.WebLogicDelegate (for WebLogic drivers)
org.quartz.impl.jdbcjobstore.oracle.OracleDelegate
org.quartz.impl.jdbcjobstore.oracle.WebLogicOracleDelegate (for Oracle drivers used within Weblogic)
org.quartz.impl.jdbcjobstore.oracle.weblogic.WebLogicOracleDelegate (for Oracle drivers used within Weblogic)
org.quartz.impl.jdbcjobstore.CloudscapeDelegate
org.quartz.impl.jdbcjobstore.DB2v6Delegate
org.quartz.impl.jdbcjobstore.DB2v7Delegate
org.quartz.impl.jdbcjobstore.DB2v8Delegate
org.quartz.impl.jdbcjobstore.HSQLDBDelegate
org.quartz.impl.jdbcjobstore.PointbaseDelegate
org.quartz.impl.jdbcjobstore.SybaseDelegate

Synchronizer

Parameter	Description	Default*
DIRIGIBLE_SYNCHRONIZER_IGNORE_DEPENDENCIES	Whether to ignore dependencies for synchronizers, e.g. for tests purposes	`false`

Job Expression

Parameter	Description	Default*
DIRIGIBLE_JOB_EXPRESSION_BPM	BPM synchronizer job config	`0/50 * * * ?`*
DIRIGIBLE_JOB_EXPRESSION_DATA_STRUCTURES	Data structures job synchronizer config	`0/25 * * * ?`*
DIRIGIBLE_JOB_EXPRESSION_EXTENSIONS	Extension synchronizer job config	`0/10 * * * ?`*
DIRIGIBLE_JOB_EXPRESSION_JOBS	Jobs synchronizer job config	`0/15 * * * ?`*
DIRIGIBLE_JOB_EXPRESSION_MESSAGING	Messaging synchronizer job config	`0/25 * * * ?`*
DIRIGIBLE_JOB_EXPRESSION_MIGRATIONS	Migration synchronizer job config	`0/55 * * * ?`*
DIRIGIBLE_JOB_EXPRESSION_ODATA	OData synchronizer job config	`0/45 * * * ?`*
DIRIGIBLE_JOB_EXPRESSION_PUBLISHER	Publisher synchronizer job config	`0/5 * * * ?`*
DIRIGIBLE_JOB_EXPRESSION_SECURITY	Security synchronizer job config	`0/20 * * * ?`*
DIRIGIBLE_JOB_EXPRESSION_REGISTRY	Registry synchronizer job config	`0/35 * * * ?`*
DIRIGIBLE_JOB_DEFAULT_TIMEOUT	Default timeout in minutes	`3`

Runtime Core

Parameter	Description	Default*
DIRIGIBLE_HOME_URL	The home URL where the user to be redirected on access	`/services/v4/web/ide/index.html`

Vert.x

Parameter	Description	Default*
DIRIGIBLE_VERTX_PORT	The Vert.x server port, if used	`8888`

CMS

Parameter	Description	Default*
DIRIGIBLE_CMS_PROVIDER	The type of the CMS provider used in this instance (e.g. `internal`, `managed` or `database`)	`internal`
DIRIGIBLE_CMS_ROLES_ENABLED	Whether the RBAC over the CMS content to be enabled	`true`

CMS - Internal

Parameter	Description	Default*
DIRIGIBLE_CMS_INTERNAL_ROOT_FOLDER	The location of the CMS internal repository	`target`
DIRIGIBLE_CMS_INTERNAL_ROOT_FOLDER_IS_ABSOLUTE	Whether the root folder parameter is absolute or not	`false`

CMS - Managed

Parameter	Description	Default*
DIRIGIBLE_CMS_MANAGED_CONFIGURATION_JNDI_NAME	The JNDI name of the managed CMS repository	`java:comp/env/EcmService` in case of SAP package
DIRIGIBLE_CMS_MANAGED_CONFIGURATION_AUTH_METHOD	The authentication method (e.g. `key` or `destination`)	`key`
DIRIGIBLE_CMS_MANAGED_CONFIGURATION_NAME	The name of the repository	`cmis:dirigible`
DIRIGIBLE_CMS_MANAGED_CONFIGURATION_KEY	The key of the repository	`cmis:dirigible:key`
DIRIGIBLE_CMS_MANAGED_CONFIGURATION_DESTINATION	The name of the destination where the name and the key for the repository are stored (e.g. `CMIS_DESTINATION`)	`-`
DIRIGIBLE_CONNECTIVITY_CONFIGURATION_JNDI_NAME	The JNDI name of the connectivity configuration serivce	`java:comp/env/connectivity/Configuration` in case of SAP package

CMS Database

Parameter	Description	Default*
DIRIGIBLE_CMS_DATABASE_DATASOURCE_TYPE	Type of the database for CMS repository (e.g. `local`, `managed`, `custom`, `dynamic`)	`managed`
DIRIGIBLE_CMS_DATABASE_DATASOURCE_NAME	The datasource name	`DefaultDB`

BPM

Parameter	Description	Default*
DIRIGIBLE_BPM_PROVIDER	The provider of the BPM engine (e.g. `internal`, `managed`, `remote`)	`internal`

BPM - Flowable

Parameter	Description	Default*
DIRIGIBLE_FLOWABLE_DATABASE_DRIVER	The driver of the Flowable engine (e.g. `org.postgresql.Driver`)	`-`
DIRIGIBLE_FLOWABLE_DATABASE_URL	The URL of the Flowable engine (e.g. `jdbc:postgresql://localhost:5432/<database-name>`)	`-`
DIRIGIBLE_FLOWABLE_DATABASE_USER	The user of the Flowable engine	`-`
DIRIGIBLE_FLOWABLE_DATABASE_PASSWORD	The driver of the Flowable engine	`-`
DIRIGIBLE_FLOWABLE_DATABASE_DATASOURCE_NAME	The datasource name of the Flowable engine, if any configured	`-`
DIRIGIBLE_FLOWABLE_DATABASE_SCHEMA_UPDATE	Whether to materialize the database layout or not	`true`
DIRIGIBLE_FLOWABLE_USE_DEFAULT_DATABASE	Whether to use the DefaultDB datasource or built-in H2 (e.g. `true` (DefaultDB) or `false` (H2))	`true`

Mail

Parameter	Description	Default*
DIRIGIBLE_MAIL_USERNAME	Mailbox username	`-`
DIRIGIBLE_MAIL_PASSWORD	Mailbox password	`-`
DIRIGIBLE_MAIL_TRANSPORT_PROTOCOL	Mail transport protocol	`smtps`
DIRIGIBLE_MAIL_SMTPS_HOST	Mailbox SMTPS host	`-`
DIRIGIBLE_MAIL_SMTPS_PORT	Mailbox SMTPS port	`-`
DIRIGIBLE_MAIL_SMTPS_AUTH	Enable/disable mailbox SMTPS authentication	`-`
DIRIGIBLE_MAIL_SMTP_HOST	Mailbox SMTP host	`-`
DIRIGIBLE_MAIL_SMTP_PORT	Mailbox SMTP port	`-`
DIRIGIBLE_MAIL_SMTP_AUTH	Enable/disable mailbox SMTP authentication	`-`

Messaging

Parameter	Description	Default*
DIRIGIBLE_MESSAGING_USE_DEFAULT_DATABASE	Whether to use the DefaultDB datasource or built-in KahaDB (e.g. `true` (DefaultDB) or `false` (KahaDB))	`true`

Kafka

Parameter	Description	Default*
DIRIGIBLE_KAFKA_BOOTSTRAP_SERVER	The Kafka server location	`localhost:9092`
DIRIGIBLE_KAFKA_ACKS	The number of brokers that must receive the record before considering the write as successful	`all`
DIRIGIBLE_KAFKA_KEY_SERIALIZER	The Key serializer	`org.apache.kafka.common.serialization.StringSerializer`
DIRIGIBLE_KAFKA_VALUE_SERIALIZER	The Value serializer	`org.apache.kafka.common.serialization.StringSerializer`
DIRIGIBLE_KAFKA_AUTOCOMMIT_ENABLED	Whether Auto Commit is enabled	`true`
DIRIGIBLE_KAFKA_AUTOCOMMIT_INTERVAL	Auto Commit interval in ms	`1000`

Engines

JavaScript

Parameter	Description	Default*
DIRIGIBLE_JAVASCRIPT_ENGINE_TYPE_DEFAULT	The type of the JavaScript engine provider used in this instance (e.g. `graalvm`, `rhino`, `nashorn` or `v8`)	`graalvm` since 5.0

GraalVM

Parameter	Description	Default*
DIRIGIBLE_JAVASCRIPT_GRAALVM_DEBUGGER_PORT	The GraalVM debugger port	`8081` and `0.0.0.0:8081` in Docker environment
DIRIGIBLE_JAVASCRIPT_GRAALVM_ALLOW_HOST_ACCESS	Whether GraalVM can load classes form custom packages	`true`
DIRIGIBLE_JAVASCRIPT_GRAALVM_ALLOW_CREATE_THREAD	Whether GraalVM can create threads	`true`
DIRIGIBLE_JAVASCRIPT_GRAALVM_ALLOW_CREATE_PROCESS	Whether GraalVM can make IO operations	`true`
DIRIGIBLE_JAVASCRIPT_GRAALVM_ALLOW_IO	Whether GraalVM can make IO operations	`true`
DIRIGIBLE_JAVASCRIPT_GRAALVM_COMPATIBILITY_MODE_NASHORN	Whether GraalVM has enabled compatibility mode for Nashorn	`true`
DIRIGIBLE_JAVASCRIPT_GRAALVM_COMPATIBILITY_MODE_MOZILLA	Whether GraalVM has enabled compatibility mode for Mozilla	`false`

OData

Parameter	Description	Default*
DIRIGIBLE_ODATA_HANDLER_EXECUTOR_TYPE	The type of the JavaScript engine to be used for event handlers in OData
DIRIGIBLE_ODATA_HANDLER_EXECUTOR_ON_EVENT	The location of the wrapper helper to be used for event handlers in OData

Operations

Logs

Parameter	Description	Default*
DIRIGIBLE_OPERATIONS_LOGS_ROOT_FOLDER_DEFAULT	The folder where the log files are stored in	`../logs`
DIRIGIBLE_EXEC_COMMAND_LOGGING_ENABLED	Whether to log the executed command by the exec API	`false`

Look & Feel

Theme

Parameter	Description	Default*
DIRIGIBLE_THEME_DEFAULT	The name of the default name	`Default`

Destinations

Parameter	Description	Default*
DIRIGIBLE_DESTINATIONS_PROVIDER	The name of the Destinations Service provider used in this instance	`local` or `managed`
DIRIGIBLE_DESTINATIONS_INTERNAL_ROOT_FOLDER	The location of the Destinations internal repository	`target`
DIRIGIBLE_DESTINATIONS_INTERNAL_ROOT_FOLDER_IS_ABSOLUTE	Whether the root folder parameter is absolute or not	`false`
DIRIGIBLE_DESTINATION_CLIENT_ID	The Destination Service instance client id	`-`
DIRIGIBLE_DESTINATION_CLIENT_SECRET	The Destination Service instance client secret	`-`
DIRIGIBLE_DESTINATION_URL	The Destination Service instance url	`-`
DIRIGIBLE_DESTINATION_URI	The Destination Service instance uri	`-`

Terminal

Parameter	Description	Default*
DIRIGIBLE_TERMINAL_ENABLED	Whether the `Terminal` view is enabled	`true`