"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.
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
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)
-
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
Lifecycle
Parameter
Description
Default*
DIRIGIBLE_PUBLISH_DISABLED
Disable publishing process in this instance
false
Local Repository
Parameter
Description
Default*
DIRIGIBLE_REPOSITORY_LOCAL_ROOT_FOLDER
The location of the root folder where the repository artifacts will be stored