This topic is under construction for the 24.3 (March 2024) release of LabKey Server with embedded Tomcat 10. For the previous documentation, click here.
Follow this checklist to manually upgrade LabKey Server to a new version. The process assumes that you have previously installed LabKey using the recommended directory structure described in
Install on Linux: Main Components.
This topic also assumes that you are upgrading to use embedded Tomcat for the first time. Versions 23.11 and earlier used a standalone installation (of Tomcat 9) and different configuration method. You'll be able to draw configuration information from that previous installation to make it easier to upgrade to version 24.3 with embedded Tomcat 10. In future, the upgrade will be even simpler for you.
If you are upgrading from an older version of LabKey, please review
the documentation archives for the previous upgrade process to bring your server to version 23.11 prior to following these steps.
Pre-Upgrade Steps
Notify Users
Upgrade All Dependencies
- Before upgrading LabKey Server, it is important to upgrade Java, and your database (PostgreSQL or SQL Server) to their recommended versions. For details see: Supported Technologies
Backup Existing Installation
In the unlikely event that you need to go back to the previous installation of LabKey with Tomcat 9, it will be important to be able to start from the same baseline with more configuration detail than for a usual upgrade.
- Ensure you have a copy of the binaries used to install the existing LabKey Server.
- Stop Tomcat and back up your existing database, files and configuration and log files.
- Back up your existing Tomcat configuration, including files in the /etc/default directory and the systemmd service that starts Tomcat.
- Confirm which user is being used to start your Tomcat service (the TOMCAT_USER). This should not be the root user for security reasons.
Expected Directory Structure
If you did not install using the
recommended directory structure, this is a great time to make the switch. In particular, we use LABKEY_HOME and similar variables to make the documentation simpler, so using our default locations will make the instructions easier to follow.
This topic assumes the following structure, each of of these directories and their contents is assigned to the TOMCAT_USER identified above.
Variable | Linux default location | Contents |
---|
LABKEY_ROOT | /labkey | The top level under which all LabKey-related files are nested. |
| /labkey/backup | The location for storing backups. |
| /labkey/tomcat OR /labkey/apps/tomcat | This is where your previous Tomcat version was installed (i.e. TOMCAT_HOME) |
| /labkey/tomcat/SSL OR /labkey/apps/tomcat | This is where your existing Java KeyStore is located. |
| /labkey/src | This is where your current and past LabKey tar.gz installation binaries are saved. |
LABKEY_HOME | /labkey/labkey | This is where the actual LabKey application is located. |
| /labkey/tomcat-tmp | The Tomcat temp directory that LabKey will be using after the upgrade. |
Download the New LabKey Server Distribution
- Navigate to the directory LABKEY_ROOT/src, the base directory for downloading and unpacking distributions:
- Obtain the distribution tar.gz file:
- Premium Edition users can download their custom distribution from the Server Builds section of their client portal.
- Community Edition users can register and download the distribution package at Download LabKey Server Community Edition.
- To download the Linux/OSX package, you can get the URL from the link to Download tar.gz and use wget, for example:
The name of the distribution archive includes...
TBD
Related Topics