LCA Collaboration Server 2.1 – Installation Guide

This document provides a step-by-step guide for installing LCA Collaboration Server 2.1. While we recommend using Ubuntu 20.04 as the operating system, you can use any other operating system with similar installation steps.

Requirements

Before installing LCA Collaboration Server 2.1, ensure that the following software is installed on your server:

  • Java 17
  • Tomcat 10
  • MySQL/MariaDB
  • (Optional) Apache2 or Nginx

Step 1: Installation of Java 17, Tomcat 10, MySQL/MariaDB, and Optionally Apache2 or Nginx as Reverse Proxy

Please refer to the installation instructions for each required software package.

Step 2: Creation of an Empty Directory (Skip this step if migrating from LCA Collaboration Server 1.3.0)

Create an empty directory on your server where you intend to store LCA Collaboration Server data. For example, you can create a directory named /opt/collab.

Step 3: Creation of an Empty Database

Create an empty MySQL database to be used by LCA Collaboration Server. For example, you can create a database named collaboration-server.

Step 4: Running the Installer

To install the LCA Collaboration Server, run the LCA Collaboration Server Installer jar file. Follow the prompts provided below to complete the installation:

 

  • Path to the current database directory: /opt/collab/database *, **
  • Path to the data directory for the collaboration server (should be empty): /opt/collab **
  • MySQL hostname: localhost
  • MySQL port: 3306
  • MySQL database: collaboration-server
  • MySQL user: collaboration-server
  • MySQL password: collaboration-server

* Only prompted when choosing ‘migrate’
** The installer must be run by a user with sufficient access privileges

Note: Modify these prompts as per your server configuration, if necessary.

Step 5: Setting Access Rights

Configure access rights to grant ownership and write access to the tomcat user for the collab directory with “chown tomcat:tomcat /opt/collab -R”. Additionally, configure the tomcat service to have write access (ReadWritePaths=/opt/collab).

Step 6: Update WEB-INF/classes/application.properites

If you used different parameters for the MySQL server than those provided in this documentation, adjust the application.properties file. It is recommended to edit the file within the WAR file before deployment, but you can also edit the file after deployment.

Step 7: Updating .html files

If the LCA Collaboration Server is not running in the server’s root context, modify all .html files in the root directory. Adjust the base tag to match the context path. For example, if it runs at domain.com/subcontext, update the value to <base href=”/subcontext/”/>

Step 8: Deploying the LCA Collaboration Server Application

Please transfer the LCA Collaboration Server war file to the webapps directory of your Tomcat10 server. If you plan to execute it in the root context, rename the file as ROOT.war before uploading. Otherwise, rename it as {context-path}.war according to the desired context path where you want it to be accessible.

Step 9: Optional – Configuring Apache2 as a Reverse Proxy

If you would like to configure Apache2 as a reverse proxy for the LCA Collaboration Server, please follow the instructions provided by Apache2.

Step 10: Optional – Install OpenSearch to enable the LCA Collaboration Server Search feature

If you would like to enable users to search for data sets on your LCA Collaboration Server, please follow the installation instructions provided by OpenSearch. Additionally look at Step 3.2 in the OpenSearch installation guide (see link below) and include the line plugins.security.disabled: true in your opensearch config. This will disable SSL which is not required, when connecting from localhost to localhost and if the opensearch port is not open for external use.

Helpful links (Ubuntu install)

Next steps on configuration here.