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/centralConfigurationfolder



  • 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

    System.conf config migration

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

    Config files migration

    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.

List of configuration files in the XL_DEPLOY_SERVER_HOME/conf folder

Configuration file name Description
xl-deploy.conf The file contains the main configuration used by the Deploy Server. This file is in HOCON format. After the first run, passwords in the configuration file will be encrypted and replaced with the base64-encoded encrypted values.Detailed properties descriptions are listed in the xl-deploy.conf.example that is located in the installation directory. Any changes on the properties inside xl-deploy.conf are applied only after a server restart.
xl-worker.conf This file is available for Deploy versions 8.6 and later. The configuration is used exclusively by a Deploy worker. This configuration is optional, worker configuration can be added to xl-deploy.conf. Configuration contains settings of worker hostname (xl.server.hostname) and port (xl.server.port).
deployit.conf Security and accessibility configuration settings generated on the Deploy server or CLI startup. The default location of the file is XL_DEPLOY_HOME/conf directory. Passing -configuration configuration_directory to the start script will change the location of the deployit.conf file. Detailed properties descriptions are listed in table below. The default set of application configuration settings generated on the Deploy server or CLI startup. The main properties descriptions are listed in a separate document.
command-whitelist.json Configuration used to blacklist / whitelist commands used in the command plugin. Configuration properties for logging.
logback-access.xml Logger configuration file for the access log.
logback.xml Logger configuration file for the Deploy Server or for the worker log.
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.conf.posix Specific Linux-based configuration used for running wrapper. Specific Windows configuration used for running wrapper.
xld-wrapper-server.conf Configuration used to install a Deploy server as a service.
xld-wrapper-worker.conf Configuration used to install a Deploy worker as a service.
wrapper-daemon.vm Wrapper script template for Linux.

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
http.port Deploy server port 4516 Set default Web Welcome page. -
http.idle.seconds Timeout before idle HTTP connections are discarded.
http.upload.buffer Uploaded files buffer. 262144 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 When set to “true”, all deployables will be auto-mapped to containers only when you set up an initial deployment in the GUI. false 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 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.

XL_DEPLOY_SERVER_HOME/centralConfiguration Folder

This directory contains files for Deploy central configuration

A central repository where all the application configuration files are defined at one place and which avoids coping of these files for the workers.

Note:: The CentralConfiguration is in transition stage for the v.10.1 and now it is part of the XLD master. Fully upgraded CentralConfiguration would be available in the upcoming version of the Deploy and also can be an option to run it as a separate service.

The centralConfiguration is going to be a file system based configuration with defined folder and not to duplicate the configurations for the workers.

Configuration mismatch between master with workers in v.10.1 will be calculated based on files and properties left in the conf folder.

Central configuration is based on Spring Cloud Configuration.

List of configuration files in the XL_DEPLOY_SERVER_HOME/centralConfiguration Folder

Configuration file name Description
centralConfiguration/xld-command-whitelist.yaml Configuration used to blacklist / whitelist commands used in the command plugin
centralConfiguration/xld-db-anonymizer.yaml Contains the rules how the data from the database is going to be exported
centralConfiguration/xld-secret-complexity.yaml Configure password strength requirements using example secret-complexity tag
centralConfiguration/xld-client-gui.yaml You can use xld-client-gui.yaml file to customize everything related to GUI
centralConfiguration/xld-websockets.yaml Contains the ThreadPoolTaskExecutor as well as WebSocketPolicy details for message broker

Refresh configuration files

To refresh configuration files without restarting server, invoke the refresh Spring Boot Actuator endpoint manually to force the client to refresh and draw in the new value.

$ curl XLD_URL/actuator/refresh -d {} -H "Content-Type: application/json"