These topics provide step by step instructions for upgrading an existing LabKey Server installation to a newer version.

Supported Versions for Upgrade

Please see the LabKey Releases and Upgrade Support Policy page. In some cases, you may need to perform an intermediate upgrade to reach the latest version.

Best Practice: Use a Staging Server

Utilizing a Staging server, where you bring up a temporary staging server on a copy of the production database, is best practice as it will help you confirm that the production upgrade will be successful.

Learn more in this topic: Tips for Configuring a Staging Server

Upgrade Instructions

Upgrade on Linux or OSX

Upgrade on Windows

Considerations and Notes

Reset Browser Cache

After upgrade, you may need to reset your browser cache. See Troubleshooting Upgrade.

Pipeline Jobs

It is a known issue that pipeline jobs that are in progress prior to an upgrade may not resume successfully after an upgrade. The same is true for jobs that may have hit an error condition if they are retried after an upgrade. In general, hotfix releases should not have incompatibilities when resuming jobs, but major version transitions will sometimes exhibit this problem. When possible, it is recommended to let jobs complete prior to performing an upgrade.

To check the status of jobs, use the Pipeline link from the Admin Console.

Upgrade Performance

From time to time, one time migrations may result in longer upgrade times than expected for certain modules. For example, when the audit log tables rowID was changed from integer to bigInt, upgrading the audit log module may have taken an unusual length of time and disk space.

Related Topics

LabKey Cloud Hosting Available

LabKey can take care of the upgrade process for you, so that you can focus on your research. Learn more on our website:


Was this content helpful?

Log in or register an account to provide feedback

expand all collapse all