Install LabKey Manually

2024-04-28

LabKey Server is a Java web application that runs under Apache Tomcat and accesses a relational database, either PostgreSQL or Microsoft SQL Server. LabKey Server can also reserve a network file share for the data pipeline, and use an outgoing (SMTP) mail server for sending system emails. LabKey Server may optionally connect to an LDAP server to authenticate users within an organization.

If you are installing LabKey Server for evaluation purposes, we recommend that you first try the Windows Graphical Installer, which installs PostgreSQL and Tomcat for you and is faster, easier, and less prone to errors than other methods. Installing manually or on other operating systems requires moderate network and database administration skills.

Some reasons you would need to install LabKey Server manually:

  • There is an existing PostgreSQL installation on your Windows computer. Only one instance of PostgreSQL can be installed per computer. LabKey server can be manually configured to use an existing PostgreSQL installation, but the Windows Graphical Installer will fail.
  • There is an existing Tomcat installation on your Windows computer and you want LabKey Server to use it, rather than installing a new instance. Note that Tomcat can be installed multiple times on the same machine.
  • You are installing on Linux, Unix, or Macintosh.
  • You are running a non-English version of Windows.
  • The graphical installer was unsuccessful.
  • You want fine-grained control over file locations for LabKey Server in a production environment.

Step-by-Step Manual Install

If you are manually installing LabKey Server, you need to download, install, and configure all of its components yourself. The following topics explain how to do this in a step-by-step fashion:

If you are installing manually on Unix, Linux, or Macintosh, the instructions assume that you have super-user access to the machine, and that you are familiar with unix commands and utilities such as wget, tar, chmod, and ln.

Related Topics