This document describes how to perform a backup for XL Deploy version 8.0 and later. For XL Deploy version 7.6 and earlier, refer to Back up XL Deploy (XL Deploy 7.6 and earlier).

It is recommended that you regularly create a backup of your XL Deploy server. It is especially important to back up XL Deploy before upgrading to a new version.

Create a backup

Important: XL Deploy must not be running when you are creating a backup. Schedule backups outside planned deployment hours to ensure that the server is not being used.

To back up XL Deploy, it is recommended that you back up the complete installation folder (referred to here as XL_DEPLOY_SERVER_HOME); for example, by compressing it in a ZIP file.

If you store the XL Deploy repository and artifacts in an external database, back up the database using the tools provided by your database vendor. If the repository and reporting databases are configured differently, make sure you back up both databases.

Restore a backup

Important: XL Deploy must not be running when you restore a backup.

Restore the database

If you store the repository in a database server, restore the backup of the database using the tools provided by your database vendor.

Note: If you are using the default embedded database, the backup ZIP file you created will contain this database. To restore the database, replace the XL_DEPLOY_SERVER_HOME/repository directory with the contents of the backup.

Restore XL Deploy configuration

To restore your XL Deploy configuration, replace the XL_DEPLOY_SERVER_HOME/conf directory with the contents of the backup.

Restore XL Deploy customizations

To restore your XL Deploy customizations, remove the XL_DEPLOY_SERVER_HOME/ext and XL_DEPLOY_SERVER_HOME/plugins directories and replace them with the backups. If you are restoring customizations after upgrading XL Deploy, first review the upgrade procedure. Some customizations must be redone manually because some files may change between versions of XL Deploy.