Back up Deploy

This topic provides information about how to backup Deploy server.

Important: Back up Deploy before upgrading to a new version. For more information, see upgrade Deploy.

Create a backup

Important: Shut down Deploy before creating a back up. For more information, see, shut down Deploy.

Schedule backups outside planned deployment hours to ensure that the server is not being used.

To back up Deploy, we recommended that you back up the complete installation folder, referred to here as XL_DEPLOY_SERVER_HOME, by compressing it in a ZIP file.

If you store the 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, back up both databases.

Restore a backup

Important: Shut down Deploy before you restore a back up. For more information, see, shut down Deploy.

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 Deploy configuration

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

Restore Deploy customizations

To restore your 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 Deploy, review the upgrade procedure before starting. Some customizations must be redone manually because some files may change between versions of Deploy.