This page provides a suggested backup plan for an installation of LabKey Server. A backup plan may be built in many ways given different assumptions about an organization's needs. This page provides just one possible solution. You will tailor its suggestions to your LabKey Server implementation and your organization's needs.
General Guidelines
You should back up the following data in your LabKey Server:
- Database
- Site-level file root
- Pipeline root and FileContent module files
- LabKey Server configuration and log files
For some LabKey Server modules, the files (Pipeline Root or File Content Module) and the data in the database are very closely linked. Thus, it is important to time the database backup and the file system backup as closely as possible.
Store backups in $<LK_ROOT>/backupArchive, organized by subfolders within that location. Do NOT store backups under $<LABKEY_HOME>/backup (i.e. <LK_ROOT>/labkey/backup), as this location will be overwritten by the deployment.
Assumptions for Backup Plan
- Backup Frequency: For robust enterprise backup, this plan suggests performing incremental and transaction log backups hourly. In the event of a catastrophic failure, researchers will lose no more than 1 hour of work. You will tailor the frequency of all types of backups to your organization's needs.
- Backup Retention: For robust enterprise backup, this plan suggests a retention period of 7 years. This will allow researchers to be able to restore the server to any point in time within the last 7 years. You will tailor the retention period to your organization's needs.
Database Backup
- Full Backup of Database: Monthly
- This should occur on a weekend or during a period of low usage on the server.
- Differential/Incremental Backup of Database: Nightly
- For servers with large databases, use an Incremental Backup Design, meaning that you backup all changes since the last Full or Incremental backup occurred.
- Such databases may be >10GB in size or may be fast-growing. An example would be a LabKey database that supports high-throughput Proteomics.
- For Servers with smaller databases, use a Differential Backup Design, meaning that you backup all changes since the last Full backup.
- Transaction Log Backups: Hourly
Site-level File Root
- Full Backup of Files: Monthly
- This should occur on a weekend or during period of low usage on the server
- To determine the site-level file root go to:
- > Site > Admin Console > Settings > Configuration > Files.
- Back up the contents of this file root.
- Make sure to check for any file locations that have overridden the site-level file root. For a summary of file locations, go to:
- > Site > Admin Console > Settings > Configuration > Files > Expand All.
- Back up all additional file roots.
Pipeline Root or File Content Module File Backup
- Full Backup of Files: Monthly
- This should occur on a weekend or during period of low usage on the server
- Incremental Backup of Database: Hourly
LabKey Server configuration and log files
- These files are stored in the following locations:
- Log Files are located in <LABKEY_HOME>/logs
- Configuration files are located in <LABKEY_HOME>/configs
- Full Backup of Files: Monthly
- This should occur on a weekend or during period of low usage on the server
- Incremental Backup of Database: Nightly
Related Topics
