Start Release

This topic describes how to start the Release server on different operating systems, either interactively or as a background process.

To start the Release server, open a command prompt or terminal, point to the XL_RELEASE_SERVER_HOME/bin directory, and execute the appropriate command:

1. Open a command prompt or terminal.

2. Point to the XL_RELEASE_SERVER_HOME/bin directory.

3. Execute the appropriate command:

   Operating system	Command
   Microsoft Windows	run.cmd
   Unix-based systems	run.sh

Start Release in the Background

important

To run Release in the background, it must be configured to start without any user interaction. The server should not require a password for the encryption key that is used to protect the passwords in the repository. Alternatively, you can store the password in the XL_RELEASE_SERVER_HOME/conf/xl-release-server.conf file, by adding repository.keystore.password=MY_PASSWORD. Release will encrypt the password when you start the server.

To start the Release server as a background process,

1. Open a command prompt or terminal.

2. Point to the XL_RELEASE_SERVER_HOME/bin directory.

3. Execute the appropriate command:

   Operating system	Command
   Microsoft Windows	START /B run.cmd
   Unix-based systems	nohup bin/run.sh &

important

If you close the command prompt in Microsoft Windows, Release will stop.

Server options

Specify the options you want to use when starting the Release server in the XL_RELEASE_SERVER_OPTS environment variable.

The following server options are available:

Option	Description
-force-upgrades	Forces the execution of upgrades at Release startup.
-repository-keystore-password VAL	Identifies the password to use to access the repository keystore. If not specified and the repository keystore does require a password, Release will prompt you for it.
-setup	Runs the Release setup wizard.
-setup-defaults VAL	Specifies a file that contains default values for configuration properties set in the setup wizard.
-release-db-locks	During Release upgrades, the database schema may change. If the Release is suddenly stopped, it can potentially lock the database, and prevent Release from starting up again. To address this issue, the -release-db-locks option is introduced, which will remove the lock and try applying any pending changes. It's crucial to understand that using this option will not corrupt or harm the database. This option must be used only if you see the liquibase.exception.LockException: Could not acquire change log lock error while starting Release. Note: Before utilizing this option, ensure that no other Release instance in the cluster is undergoing an upgrade simultaneously.

To view the available server options when starting the Release server, add the -h flag to the start command.