Environment Variables
Configuration Types
Based on the layer, they are defined, configuration variables have the following priorities:
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 fromdirigible.propertiesproperties file (sample could be found 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
Branding
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_BRANDING_NAME | The product name | Dirigible |
| DIRIGIBLE_BRANDING_BRAND | The brand name | Eclipse |
| DIRIGIBLE_BRANDING_BRAND_URL | The brand/product URL | https://www.dirigible.io |
| DIRIGIBLE_BRANDING_FAVICON | The brand/product favicon | /services/web/platform-branding/images/favicon.ico |
| DIRIGIBLE_BRANDING_LOGO | The brand/product logo | /services/web/platform-branding/images/dirigible.svg |
| DIRIGIBLE_BRANDING_THEME | The default theme ID | blimpkit-auto |
| DIRIGIBLE_BRANDING_PREFIX | The prefix used for cookie and localStorage value keys | blimpkit-auto |
Server
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_SERVER_PORT | The port that Eclipse Dirigible will start on | 8080 |
Basic
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_BASIC_ENABLED | Whether the Basic authentication is enabled | true |
| DIRIGIBLE_BASIC_USERNAME | Base64 encoded property, which will be used as user name for basic authentication | admin |
| DIRIGIBLE_BASIC_PASSWORD | Base64 encoded property, which will be used as password for basic authentication | admin |
OAuth
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_OAUTH_ENABLED | Whether the OAuth authentication is enabled | false |
| 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_TOKEN_REQUEST_METHOD | The OAuth token request method (GET or POST) |
GET |
| 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_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_VERIFICATION_KEY | The OAuth verificationkey (e.g. -----BEGIN PUBLIC KEY-----MIIBIjANBgkqhki...) |
- |
| DIRIGIBLE_OAUTH_VERIFICATION_KEY_EXPONENT | The OAuth verificationkey exponent (e.g. AQAB) |
- |
| DIRIGIBLE_OAUTH_CHECK_ISSUER_ENABLED | Sets whether the JWT verifier should check the token issuer |
true |
| DIRIGIBLE_OAUTH_CHECK_AUDIENCE_ENABLED | Sets whether the JWT verifier should check the token aud |
true |
| DIRIGIBLE_OAUTH_APPLICATION_NAME | The application name (e.g. dirigible-xxx) |
- |
Redirect/Callback URL
Configure the Redirect/Callback URL in the OAuth client to: <DIRIGIBLE_OAUTH_APPLICATION_HOST>/services/v4/oauth/callback
Keycloak
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_KEYCLOAK_ENABLED | Sets whether the Keycloak Authentication is enabled* | false |
| DIRIGIBLE_KEYCLOAK_AUTH_SERVER_URL | The Keycloak Authentication Server URL (e.g. https://keycloak-server/auth/) |
- |
| DIRIGIBLE_KEYCLOAK_REALM | The Keycloak realm (e.g. my-realm) |
- |
| DIRIGIBLE_KEYCLOAK_SSL_REQUIRED | The Keyclaok SSL Required (e.g. none/external) |
- |
| DIRIGIBLE_KEYCLOAK_CLIENT_ID | The Keycloak Client ID (e.g. my-client) |
- |
| DIRIGIBLE_KEYCLOAK_CONFIDENTIAL_PORT | The Keycloak Confidential Port (e.g. 443) |
- |
| DIRIGIBLE_KEYCLOAK_CONFIDENTIAL_PORT | The Keycloak Confidential Port (e.g. 443) |
- |
| DIRIGIBLE_MULTI_TENANT_MODE_KEYCLOAK_SINGLE_REALM | Whether single realm multitenancy mode is enabled | false |
| SERVER_MAXHTTPHEADERSIZE | The HTTP header max size (e.g. 48000) |
Default for the underlying server (e.g. Tomcat) |
Note
In addition to setting the DIRIGIBLE_KEYCLOAK_ENABLED property to true, the DIRIGIBLE_BASIC_ENABLED property should be set to false in order to enable the Keycloak integration.
To find more details about the Keycloak configuration go to Keycloak Java Adapter Configuration.
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 |
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 |
Repository Versioning
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_REPOSITORY_VERSIONING_ENABLED | The flag whether versioning for repository is enabled | false |
Database
Common Parameters
| 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_DATASOURCE_DEFAULT_DRIVER | The driver used for the DefaultDB database connection | org.h2.Driver |
| DIRIGIBLE_DATASOURCE_DEFAULT_URL | The JDBC url used for the DefaultDB database connection | jdbc:h2:file:./target/dirigible/h2/DefaultDB |
| DIRIGIBLE_DATASOURCE_DEFAULT_USERNAME | The username used for the DefaultDB database connection | sa |
| DIRIGIBLE_DATASOURCE_DEFAULT_PASSWORD | The password used for the DefaultDB database connection | (empty) |
| 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_DEFAULT_QUERY_LIMIT | The batch size used during quering data from the database | _1000 |
| 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_TRANSFER_BATCH_SIZE | The batch size used during the data transfer | 1000 |
| DIRIGIBLE_DATABASE_SYSTEM_DIALECT | The driver dialect for the SystemDB database (e.g. org.hibernate.dialect.PostgreSQLDialect) |
- |
| DIRIGIBLE_DATABASE_SYSTEM_DDL_AUTO | The DDL auto configuration for the SystemDB database (e.g. update, create, create-drop, validate, none) |
- |
| DIRIGIBLE_DATABASE_SYSTEM_DRIVER | The driver used for the SystemDB database connection | org.h2.Driver |
| DIRIGIBLE_DATABASE_SYSTEM_URL | The JDBC url used for the SystemDB database connection | jdbc:h2:file:./target/dirigible/h2/SystemDB |
| DIRIGIBLE_DATABASE_SYSTEM_USERNAME | The username used for the SystemDB database connection | sa |
| DIRIGIBLE_DATABASE_SYSTEM_PASSWORD | The password used for the SystemDB database connection | (empty) |
Custom Database
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_DATABASE_PROVIDER | The name of the database provider which will be used in this instance to be set to custom | local |
| DIRIGIBLE_DATABASE_CUSTOM_DATASOURCES | The list of the custom data sources names used in this instance e.g. DS1,DS2 |
`` |
| DIRIGIBLE_DATABASE_DATASOURCE_NAME_DEFAULT | The name of the primary data source used in this instance e.g. DS1 |
DefaultDB |
| DS1_DRIVER | The JDBC driver used for the exemplary DS1 database connection |
`` |
| DS1_URL | The JDBC url used for the exemplary DS1 database connection |
`` |
| DS1_SCHEMA | The default schema used for the exemplary DS1 database connection |
`` |
| DS1_USERNAME | The username used for the exemplary DS1 database connection |
`` |
| DS1_PASSWORD | The password used for the exemplary DS1 database connection |
`` |
| DS1_MAX_LIFETIME_MINUTES | The max lifetime in minutes used for the exemplary DS1 database connection |
15 |
| DS1_LEAK_DETECTION_THRESHOLD_MINUTES | The leak detection threshold in minutes used for the exemplary DS1 database connection |
1 |
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 | - |
Database Snowflake
| Parameter | Description | Default* |
|---|---|---|
| SNOWFLAKE_DATABASE | The database used by Snowflake | - |
| SNOWFLAKE_SCHEMA | The schema used by Snowflake | - |
| SNOWFLAKE_WAREHOUSE | The warehouse used by Snowflake | - |
| SNOWFLAKE_DEFAULT_TABLE_TYPE | Default table type for create table statements | HYBRID |
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 |
Lifecycle
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_PUBLISH_DISABLED | Disable publishing process in this instance | false |
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_LOGS_RETANTION_PERIOD | The period the logs of the job execution will be kept (the default is one week - 24x7) | 168 |
| DIRIGIBLE_SCHEDULER_EMAIL_SENDER | The sender for the e-mail notifications | - |
| DIRIGIBLE_SCHEDULER_EMAIL_RECIPIENTS | The recipients list for the e-mail notifications | - |
| DIRIGIBLE_SCHEDULER_EMAIL_SUBJECT_ERROR | The error subject for the e-mail notifications | - |
| DIRIGIBLE_SCHEDULER_EMAIL_SUBJECT_NORMAL | The normal subject for the e-mail notifications | - |
| DIRIGIBLE_SCHEDULER_EMAIL_TEMPLATE_ERROR | The error template for the e-mail notifications | - |
| DIRIGIBLE_SCHEDULER_EMAIL_TEMPLATE_NORMAL | The normal template for the e-mail notifications | - |
| DIRIGIBLE_SCHEDULER_EMAIL_URL_SCHEME | The scheme part of the URL for the e-mail notifications | - |
| DIRIGIBLE_SCHEDULER_EMAIL_URL_HOST | The host part of the URL for the e-mail notifications | - |
| DIRIGIBLE_SCHEDULER_EMAIL_URL_PORT | The port part of the URL for the e-mail notifications | - |
| DIRIGIBLE_SCHEDULER_DATABASE_DELEGATE | The name of the JDBC delegate used by Quartz, if not the default one | org.quartz.impl.jdbcjobstore.StdJDBCDelegate |
Note
Quartz JDBC delegates:
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.PostgreSQLDelegateorg.quartz.impl.jdbcjobstore.WebLogicDelegate(for WebLogic drivers)org.quartz.impl.jdbcjobstore.oracle.OracleDelegateorg.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.CloudscapeDelegateorg.quartz.impl.jdbcjobstore.DB2v6Delegateorg.quartz.impl.jdbcjobstore.DB2v7Delegateorg.quartz.impl.jdbcjobstore.DB2v8Delegateorg.quartz.impl.jdbcjobstore.HSQLDBDelegateorg.quartz.impl.jdbcjobstore.PointbaseDelegateorg.quartz.impl.jdbcjobstore.SybaseDelegate
Synchronizer
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_SYNCHRONIZER_IGNORE_DEPENDENCIES | Whether to ignore dependencies for synchronizers, e.g. for tests purposes | false |
| DIRIGIBLE_SYNCHRONIZER_EXCLUDE_PATHS | Paths to be excluded from processing (comma separated list) | `` |
| DIRIGIBLE_SYNCHRONIZER_CROSS_RETRY_COUNT | Cross-dependencies processing count | 10 |
| DIRIGIBLE_SYNCHRONIZER_CROSS_RETRY_INTERVAL | Cross-dependencies processing interval | 10000 |
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/10 * * * * ? |
| 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 |
CSV
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_CSV_DATA_MAX_COMPARE_SIZE | The maximum number of CSV records for which will be performed comparison with the existing table data | 1000 |
| DIRIGIBLE_CSV_DATA_BATCH_SIZE | The number of CSV records to be included in a batch operation | 100 |
CMS
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_CMS_PROVIDER | The type of the CMS provider used in this instance (e.g. cms-provider-internal, cms-provider-s3) |
cms-provider-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 |
| DIRIGIBLE_CMS_INTERNAL_VERSIONING_ENABLED | Whether the versioning of the files is enabled or not | false |
CMS - S3
| Parameter | Description | Default* |
|---|---|---|
| AWS_ACCESS_KEY_ID | The AWS access key used for authentication (optional when deployed on AWS) | target |
| AWS_SECRET_ACCESS_KEY | The AWS secret key used for authentication (optional when deployed on AWS) | target |
| DIRIGIBLE_S3_PROVIDER | The provider to be used for S3. For local testing an option with localstack is available |
aws |
| DIRIGIBLE_S3_BUCKET | The bucket to be used for content management. Will be created if the provided one does not exist | target |
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 |
| DIRIGIBLE_FLOWABLE_MAIL_SERVER_HOST | The SMTP mail server host (e.g. email-smtp.eu-central-1.amazonaws.com) |
- |
| DIRIGIBLE_FLOWABLE_MAIL_SERVER_PORT | The SMTP mail server port | 587 |
| DIRIGIBLE_FLOWABLE_MAIL_SERVER_USERNAME | The SMTP mail server username | - |
| DIRIGIBLE_FLOWABLE_MAIL_SERVER_PASSWORD | The SMTP mail server password | - |
| DIRIGIBLE_FLOWABLE_MAIL_SERVER_USE_TLS | Whether the SMTP mail server TLS is enabled | true |
| DIRIGIBLE_FLOWABLE_MAIL_SERVER_USE_SSL | Whether the SMTP mail server SSL is enabled | false |
| DIRIGIBLE_FLOWABLE_MAIL_SERVER_DEFAULT_FROM | The default mail sender address (e.g. no-reply@example.com) |
- |
| 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_GRAALIUM_ENABLE_DEBUG | Whether the debug mode is enabled | false |
| 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 |
TypeScript
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_PROJECT_TYPESCRIPT | Whether the project is TypeScript enabled | true |
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 |
FTP
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_FTP_USERNAME | The FTP server username | admin |
| DIRIGIBLE_FTP_PASSWORD | The FTP server password | admin |
| DIRIGIBLE_FTP_PORT | The FTP server port | 8022 |
SFTP
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_SFTP_USERNAME | The SFTP server username | admin |
| DIRIGIBLE_SFTP_PASSWORD | The SFTP server password | admin |
| DIRIGIBLE_SFTP_PORT | The SFTP server port | 8022 |
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 |
Terminal
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_TERMINAL_ENABLED | Whether the Terminal view is enabled |
true |
Multitenancy
| Parameter | Description | Default* |
|---|---|---|
| DIRIGIBLE_MULTI_TENANT_MODE | Whether the Eclipse Dirigible is in multitenant mode or not | true |
| DIRIGIBLE_TENANT_SUBDOMAIN_REGEX | A regex which is used to extract the tenant subdomain from the host of the requests. This subdomain is used to resolve the current tenant. | ^([^\.]+)\..+$ |