Deploy configuration files
This topic describes the Deploy configuration files that can be found in the XL_DEPLOY_SERVER_HOME/conf folder
Important:
-
As of version 8.6, the
system.conf,maven.conf,extensions.conf,planner.conf, andscheduler.confconfiguration files have been deprecated. The configuration properties from these files have been moved to thexlblock of thexl-deploy.conffile
Note For
maven.conffile, the configuration is moved intoxl.artifact.resolver.
The file
xl-deploy.conf.examplein theconffolder 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
xlblock in thexl-deploy.conffile.
List of configuration files
| 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. |
| deployit-defaults.properties | 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. |
| logging.properties | 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. |
| 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-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 | 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 | - |
| 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.