Skip to content

General configuration

General configuration of Ontrack.

Name Environment Description Default value Notes
ontrack.config.application-working-dir ONTRACK_CONFIG_APPLICATION_WORKING_DIR Directory which contains all the working files of Ontrack. It is usually set by the installation. work/files
ontrack.config.build-filter-count-max ONTRACK_CONFIG_BUILD_FILTER_COUNT_MAX # Maximum number of builds which can be returned by a build filter. Any number above is truncated down to this value 200
ontrack.config.configuration-test ONTRACK_CONFIG_CONFIGURATION_TEST Testing the configurations of external configurations. Used only for internal testing, to disable the checks when creating external configurations. true
ontrack.config.documents.engine ONTRACK_CONFIG_DOCUMENTS_ENGINE engine field jdbc
ontrack.config.file-key-store.directory ONTRACK_CONFIG_FILE_KEY_STORE_DIRECTORY directory field
ontrack.config.jobs.orchestration ONTRACK_CONFIG_JOBS_ORCHESTRATION Interval (in minutes) between each refresh of the job list 2
ontrack.config.jobs.paused-at-startup ONTRACK_CONFIG_JOBS_PAUSED_AT_STARTUP Set to true to not start any job at application startup. The administrator can restore the scheduling jobs manually false
ontrack.config.jobs.pool-size ONTRACK_CONFIG_JOBS_POOL_SIZE Number of threads to use to run the background jobs 10
ontrack.config.jobs.scattering ONTRACK_CONFIG_JOBS_SCATTERING Enabling the scattering of jobs. When several jobs have the same schedule, this can create a peak of activity, potentially harmful for the performances of the application. Enabling scattering allows jobs to be scheduled with an additional delay, computed as a fraction of the period. true
ontrack.config.jobs.scattering-ratio ONTRACK_CONFIG_JOBS_SCATTERING_RATIO Scattering ratio. Maximum fraction of the period to take into account for the scattering. For example, setting 0.5 would not add a period greater than half the period of the job. Setting 0 would actually disable the scattering altogether. 1.0
ontrack.config.jobs.timeout ONTRACK_CONFIG_JOBS_TIMEOUT # Global timeout for all jobs. Any job running longer than this time will be forcibly stopped (expressed by default in hours) PT4H
ontrack.config.jobs.timeout-controller-interval ONTRACK_CONFIG_JOBS_TIMEOUT_CONTROLLER_INTERVAL Amount of time to wait between two controls of the job timeouts (expressed by default in minutes) PT15M
ontrack.config.key-store ONTRACK_CONFIG_KEY_STORE Key store type to use to store encryption keys file
ontrack.config.search.index.batch ONTRACK_CONFIG_SEARCH_INDEX_BATCH When performing full indexation, the indexation is performed by batch. The parameter below allows to set the size of this batch processing. Note: this is a default batch size. Custom indexers can override it. 1000
ontrack.config.search.index.ignore-existing ONTRACK_CONFIG_SEARCH_INDEX_IGNORE_EXISTING Option to ignore errors when creating indexes. For test only, allowing for concurrent testing. true
ontrack.config.search.index.immediate ONTRACK_CONFIG_SEARCH_INDEX_IMMEDIATE By default, indexation is ElasticSearch is done after some time after the index has been requested. The flag below forces the index to be refreshed immediately. This SHOULD NOT be used in production but is very useful when testing Ontrack search capabilities false
ontrack.config.search.index.logging ONTRACK_CONFIG_SEARCH_INDEX_LOGGING When performing full indexation, the indexation is performed by batch. The parameter below allows to generate additional logging when indexing actions are actually taken. false
ontrack.config.search.index.reset ONTRACK_CONFIG_SEARCH_INDEX_RESET Forces a reset of all indexes at startup false
ontrack.config.search.index.tracing ONTRACK_CONFIG_SEARCH_INDEX_TRACING When performing full indexation, the indexation is performed by batch. The parameter below allows to generate additional deep level logging for all actions on Git issues. Note: if set to true this generates a lot of information at DEBUG level. false
ontrack.config.security.authorization.admin.email ONTRACK_CONFIG_SECURITY_AUTHORIZATION_ADMIN_EMAIL email field admin@ontrack.local
ontrack.config.security.authorization.admin.force ONTRACK_CONFIG_SECURITY_AUTHORIZATION_ADMIN_FORCE force field false
ontrack.config.security.authorization.admin.full-name ONTRACK_CONFIG_SECURITY_AUTHORIZATION_ADMIN_FULL_NAME fullName field Administrator
ontrack.config.security.authorization.admin.group-name ONTRACK_CONFIG_SECURITY_AUTHORIZATION_ADMIN_GROUP_NAME groupName field Administrators
ontrack.config.security.authorization.jwt.claims.email ONTRACK_CONFIG_SECURITY_AUTHORIZATION_JWT_CLAIMS_EMAIL email field
ontrack.config.security.authorization.jwt.claims.groups ONTRACK_CONFIG_SECURITY_AUTHORIZATION_JWT_CLAIMS_GROUPS groups field
ontrack.config.security.authorization.jwt.debug ONTRACK_CONFIG_SECURITY_AUTHORIZATION_JWT_DEBUG debug field false
ontrack.config.security.authorization.jwt.typ ONTRACK_CONFIG_SECURITY_AUTHORIZATION_JWT_TYP typ field
ontrack.config.security.authorization.provisioning ONTRACK_CONFIG_SECURITY_AUTHORIZATION_PROVISIONING provisioning field true
ontrack.config.security.cors.allowed-origins.<0> ONTRACK_CONFIG_SECURITY_CORS_ALLOWED_ORIGINS_<0> Origins (scheme, host and port, like https://portal.example.com) allowed to call the API - /graphql, /rest/** and /extension/** - from a browser. Empty by default: the API answers no cross-origin browser call at all, which is all the Yontrack UI needs since it calls the API from its own server. /hook/** never accepts cross-origin calls. Empty list
ontrack.config.security.tokens.validity ONTRACK_CONFIG_SECURITY_TOKENS_VALIDITY validity field PT0S
ontrack.config.templating.errors ONTRACK_CONFIG_TEMPLATING_ERRORS errors field IGNORE
ontrack.config.templating.html-tags.<0> ONTRACK_CONFIG_TEMPLATING_HTML_TAGS_<0> HTML tags to accept on top of the default ones Empty list
ontrack.config.tx.retries ONTRACK_CONFIG_TX_RETRIES Number of times an ad-hoc transaction is retried when it fails because of a transient database issue, like a connection loss or an exhausted connection pool. Set to 0 to disable the retries. 3
ontrack.config.tx.retry-delay ONTRACK_CONFIG_TX_RETRY_DELAY Time to wait before the first retry of a transaction. This delay is doubled at each attempt, up to retryMaxDelay. PT1S
ontrack.config.tx.retry-max-delay ONTRACK_CONFIG_TX_RETRY_MAX_DELAY Maximum time to wait between two retries of a transaction. PT10S
ontrack.config.url ONTRACK_CONFIG_URL Root URL for this Ontrack installation, used for notifications http://localhost:3000