Backup and Restore

Learn how to create and restore backups using OrangeHRM AWS CLI.

Backing up OrangeHRM

Run the command orangehrm backup create to create a backup of your OrangeHRM-related data. The backup will be stored in $HOME/.orangehrm/backups (e.g. /home/ec2-user/.orangehrm/backups)

Additional Information on Backups

Your backup directory will contain a folder for each backup. The folder will contain a backup.tar file and a .metadata file. The tarball contains OrangeHRM data and the metadata file has information about the backup.

Around 6 MB will be used to store a backup of a fresh OrangeHRM Starter installation. Server configurations and SSL certificates will not be included.

List Existing Backups

Run the command orangehrm backup list.

Restore an Existing Backup

WARNING: Any data created after the backup will be deleted.

Run orangehrm backup restore to restore an existing backup. You can choose the backup you want to restore.

A backup of your current system will be created first. The restore process may take a few minutes based on the amount of data.

PLEASE NOTE: Your SSL certificates and server configurations will not be affected. If you want to modify or remove these, please see “Directly using Certbot to manage SSL certificates.