To start the XL Deploy server, open a command prompt or terminal, go to the XL_DEPLOY_SERVER_HOME/bin directory, and execute the appropriate command:

Operating system XL Deploy version Command
Microsoft Windows XL Deploy 4.5.x or earlier server.cmd
Microsoft Windows XL Deploy 5.0.0 or later run.cmd
Unix-based systems XL Deploy 4.5.x or earlier
Unix-based systems XL Deploy 5.0.0 or later

Start XL Deploy in the background

To run the XL Deploy server as a background process:

  • In XL Deploy 4.5.0 and earlier:
    • On Unix, use nohup bin/ &
    • On Windows, run XL Deploy as a service
  • In XL Deploy 5.0.0 and later:
    • On Unix, use nohup bin/ & or run XL Deploy as a service
    • On Windows, run XL Deploy as a service

Important: If you have installed XL Deploy as a service, you must ensure that the XL Deploy server is configured so that it can start without user interaction. For example, the server should not require a password for the encryption key that protects passwords in the repository. Alternatively, you can store the password in the XL_DEPLOY_SERVER_HOME/conf/deployit.conf file as follows:


XL Deploy will encrypt the password when you start the server.

Server options

Start the server with the -help flag to see the options it supports. They are:

Option Description
-force-upgrades Forces the execution of upgrades at XL Deploy startup. This option is supported in XL Deploy 4.5.x and later.
-recovery Attempts to recover a corrupted repository.
-repository-keystore-password VAL Specifies the password that XL Deploy should use to access the repository keystore. Alternatively, you can specify the password in the deployit.conf file with the repository.keystore.password key. If you do not specify the password and the keystore requires one, XL Deploy will prompt you for it.
-reinitialize Reinitialize the repository. This option is only available for use with the -setup option, and it is only supported when XL Deploy is using a filesystem repository. It cannot be used when you have configured XL Deploy to run against a database.
-setup Runs the XL Deploy setup wizard.
-setup-defaults VAL Specifies a file that contains default values for configuration properties in the setup wizard.

Any options you want to give the XL Deploy server when it starts can be specified in the XL_DEPLOY_SERVER_OPTS environment variable.

Tip: For information about the -setup-defaults option, refer to Install XL Deploy.