Deploy configuration files

This topic describes the Deploy configuration files that can be found in the XL_DEPLOY_SERVER_HOME/conf and XL_DEPLOY_SERVER_HOME/centralConfigurationdirectory.

XL_DEPLOY_SERVER_HOME/conf Folder

Important:

  • As of version 8.6, the system.conf, maven.conf, extensions.conf, planner.conf, and scheduler.conf configuration files have been deprecated. The configuration properties from these files have been moved to the xl block of the xl-deploy.conf file

    Note For maven.conf file, the configuration is moved into xl.artifact.resolver.

    The file xl-deploy.conf.example in the conf folder gives some examples of how to add the configuration files.

  • If you are upgrading to version 8.6 or higher and you have non-default configuration settings in the deprecated files, you must reconfigure these settings in the xl block in the xl-deploy.conf file.
  • As of version 10.1, the Deploy shared configuration files are moved to centralConfiguration directory. Some configuration properties in the conf folder are renamed and redistributed between .yaml files of the centralConfiguration directory. See Central Configuration.

List of configuration files in the XL_DEPLOY_SERVER_HOME/conf folder

Configuration file name Description
deployit-security.xml The file contains configuration settings to configure Deploy to use LDAP.
logback-access.xml Logger configuration file for the access log.
logback.xml Logger configuration file for the Deploy Server or for the worker log.
wrapper-daemon.vm Wrapper script template for Linux.
xld-wrapper.conf.posix Specific Linux-based configuration used for running wrapper.
xld-wrapper.conf.win Specific Windows configuration used for running wrapper.
xld-wrapper-server.conf Configuration used to install a Deploy server as a service.
xld-wrapper.conf.common Common configuration used for running wrapper. This configuration is set of JVM and application system properties. You can customize this file to specify common settings such as paths, log settings, memory allocations, and so on. You can make configuration changes specific to your operating system or Deploy server type using the other xld-wrapper* files provided.
xld-wrapper-worker.conf Configuration used to install a Deploy worker as a service.

Note: From Release 10.1, the configuration files are modified. For more information about the changes to the configuration files, see Central Configuration.

Note: From Release 10.1, the configuration files are modified. For more information about the changes to the configuration files, see Central Configuration.

Wrapper configuration files restructured and renamed

With version 9.5, the set of wrapper configuration files provided in the conf directory were restructured and renamed to include a common configuration file as well as specific files for Deploy server type and operating system. You will make most of your customizations in the common wrapper config file (xld-wrapper.conf.common). You can also customize the Deploy server type and operating system configuration in the specific wrapper config files that are provided. If you are upgrading to version 9.5, and had made some customizations to your wrapper config files, you will need to replicate those changes within the new wrapper config files.

List of configuration properties from the deployit.conf file

Configuration Key Configuration value Default value
admin.password Admin password used to access the system. value of this configuration item is encrypted. Notice: Admin password can be changed by writing plain text password and restarting the Server. After restarting the Server field be encrypted. -
http.context.root Deploy Server HTTP context root /
http.bind.address Deploy Server bind address 0.0.0.0
http.port Deploy server port 4516
http.welcome.page Set default Web Welcome page. -
http.idle.seconds Timeout before idle HTTP connections are discarded.
http.upload.buffer Uploaded files buffer. 262144
client.automatically.map.all.deployables When set to “true”, all deployables will be auto-mapped to containers when you set up an initial or update deployment in the GUI. true
client.automatically.map.all.deployables.on.initial When set to “true”, all deployables will be auto-mapped to containers only when you set up an initial deployment in the GUI. false
client.automatically.map.all.deployables.on.update When set to “true”, all deployables will be auto-mapped to containers only when you set up an update deployment. false
client.session.timeout.minutes Number of minutes before a user’s session is locked when the GUI is idle. 20
client.session.remember.enabled Show or hide the Keep me logged in option on the log-in screen. true
client.server_poll.delay Delay on client for starting polling on server. 30000
jcr.repository.path JCR repository location XL_DEPLOY_SERVER_HOME/repository
hide.internals Hide or show any internal server errors due to incorrect user input. false
server.resolve.application.dependencies Enable server resolved application dependencies true
threads.max Maximum number of threads for Deploy to use. 150
threads.min Minimal number of threads for Deploy to use. 30
maintenance.forbidden_paths Disabled paths on Deploy Server context deployit/task\:POST,deployit/tasks/v2\:POST,deployit/control\:POST
ssl Turn the SSL support on. false
ssl.mutual Use mutual SSL Trust Store. false
ssl.protocol Protocol to use for SSL -
keystore.path SSL Keystore path -
truststore.path Trust Store path (has to be set if mutual SSL switch is enabled) -
truststore.password Trust Store password. -
secure.cookie.enabled Enable secure cookies. false
server.mapping.override.deployed.fields.on.update Use default deployable properties setter. true
importable.packages.path Path to importable packages from the Deploy Server importablePackages

For a detailed list of xl-deploy.conf properties, see the xl-deploy.conf.example file in the XL_DEPLOY_SERVER_HOME\conf folder.

Central Configuration Directory

The XL_DEPLOY_SERVER_HOME/centralConfiguration directory contains Digital.ai Deploy shared central configuration files. This directory is a centralized repository for all the application configuration files, which are defined and stored in one place to avoid copying of the files to the workers.

For more information on Central Configuration feature, see Central Configuration.

List of configuration files in the XL_DEPLOY_SERVER_HOME/centralConfiguration Directory

Configuration file name Description
deploy-artifact-resolver.yaml Configuration to move xl.artifact.resolver (Maven Artifact Resolver) from HOCON format to artifact-resolver.yaml(yaml format)
deploy-client.yaml Configuration settings to customize the Deploy GUI
deploy-cluster.yaml Configuration settings for hard standby and active-active set up
deploy-command-whitelist.yaml Configuration used to blacklist or whitelist commands used in the command plugin
deploy-db-anonymizer.yaml Contains the rules how the data from the database will be exported
deploy-jmx.yaml Contains JMX agent configuration settings to start Deploy
deploy-metrics.yaml Configuration settings for Deploy metrics
deploy-oidc.yaml Configuration settings for keycloak authentication
deploy-plugins.yaml Configuration settings for Deploy features
deploy-repository.yaml Configuraton settings for database configuration
deploy-satellite.yaml Configuration settings to configure Deploy satellite
deploy-secret-complexity.yaml Configure password strength requirements using example secret-complexity tag
deploy-server.yaml Configuration settings related to SSL configuration with trusted certificates
deploy-task.yaml Configuration settings related to the Deploy task engine
deploy-websockets.yaml Contains the ThreadPoolTaskExecutor and the WebSocketPolicy details for message broker

Redistribution of deployit.conf configuration properties

The properties in the deployit.conf file are moved to the centralConfiguration directory, renamed, and are distributed between deploy-client.yaml and deploy-server.yaml.

Types of Details Deploy 10.1 and Earlier Releases Deploy 10.2 and Later Releases
Name of the Configuration File deployit.conf
  • deploy-client.yaml
  • deploy-server.yaml
Location of the Configuration File XL_DEPLOY_SERVER_HOME/conf XL_DEPLOY_SERVER_HOME/centralConfiguration
Properties in the Configuration File

client.automatically.map.all.deployables

client.automatically.map.all.deployables.on.initial

client.automatically.map.all.deployables.on.update

client.session.remember.enabled

importable.packages.path

maintenance.forbiddenpaths

secure.cookie.enabled

http.upload.buffer

upgrade.batch.size

server.resolve.application.dependencies

client.serverpoll.delay

server.mapping.override.deployed.fields.on.update

deploy-client.yaml:

deploy.client.automatically-map-all-deployables

deploy.client.automatically-map-all-deployables-on-initial

deploy.client.automatically-map-all-deployables-on-update

deploy.client.session-remember-enabled

deploy.client.importable-package-directory

deploy.client.maintenance.forbidden-paths

deploy.client.secure-cookie-enabled

deploy.client.upload-file-buffer-size

deploy.client.upgrade-batch-size

client.server_poll.delay

server.mapping.override.deployed.fields.on.update

deploy-server.yaml:

server.resolve.application.dependencies

Note: The unused properties, client.server_poll.delay and server.mapping.override.deployed.fields.on.update, which are not used in Digital.ai Deploy are not moved to the new configuration files.