Skip to main content
Version: Deploy 24.1

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.

Deploy Backup – Best Practices and Guidelines​

A comprehensive backup strategy is essential to prevent data loss and maintain business continuity in Digital.ai Deploy environments.

note

The following best practices are common recommendations and general guidelines. They should not be considered exhaustive or universally applicable. Carefully review, consider, and customize these practices to fit your organization's specific infrastructure, operational requirements, and compliance needs.

Identify Critical Components for Backup​

  • Database: Include both the repository and archive databases in your backup plan.
  • Filesystem: Back up the conf, ext, and hotfix directories.

Choose an Appropriate Backup Strategy​

  • Select a backup frequency and method that balances data protection, operational impact, and storage use.
  • Two common strategies:
    • Strategy One: Weekly full backup (system down), daily incremental database backups (system live), hourly database snapshots.
    • Strategy Two: Monthly full backup (system down), weekly incremental database backups (system live), daily database snapshots.
  • Choose one of the above strategies based on storage, database setup, and acceptable risk.
note

Review and update backup strategies regularly as your environment or business needs change. Select a strategy that fits your storage capacity and database setup. Using clustered databases or storing data in multiple locations can further minimize the risk of data loss while balancing backup frequency, storage costs, and operational requirements.

Minimize Downtime and Data Loss​

  • Full backups with the system down ensure data integrity but may not be practical for all organizations.
  • Incremental and snapshot backups can be performed while the system is live, with minimal risk of data inconsistency.

Automate and Monitor Backups​

  • Use automated tools and scheduling for reliable backups.
  • Monitor backup jobs and regularly verify backup integrity with test restores.

Store Backups Securely​

  • Store backups in multiple secure locations (on-premises and/or cloud).
  • Encrypt backup data and restrict access.

Document and Test Recovery Procedures​

  • Keep clear documentation of backup and restore procedures.
  • Test recovery from backups regularly to ensure effectiveness.

Customize for Your Environment​

  • Adjust these guidelines for your infrastructure, compliance, and operational needs.
  • Consult Digital.ai support or your database administrator for site-specific advice.