OSLC Connect for Jira Cloud

Deploying a WAR

This guide describes how to deploy the OSLC Connect for Jira Cloud Broker as a WAR file on an Apache Tomcat server.

Prerequisites

Java: JRE 21 or higher
Application Server: Apache Tomcat 10.1 or higher (Jakarta EE compatible)
Database: PostgreSQL 15 or higher
SSL/TLS: A valid certificate for HTTPS
OAuth credentials: From the OAuth Integration App

Reverse proxy: Before starting the installation, decide whether a reverse proxy will be placed in front of Tomcat. This choice directly affects the public URL of the Broker and cannot easily be changed later without breaking existing OSLC links. See Using a Reverse Proxy.

Delivery Contents

The delivery package contains:

webapps/oslc-connect-jira.war - The web application archive to deploy
configuration/oslc-connect-jira.xml - Tomcat context configuration template
configuration/logback.xml - Logging configuration file
configuration/setenv.sh - Environment configuration script for Linux/macOS
configuration/setenv.bat - Environment configuration script for Windows
readme.html - Quick start instructions

Step 1: Database Setup

The Broker requires a PostgreSQL database. See Database Setup for installation and configuration instructions.

Step 2: Configure Tomcat

Tomcat must be configured before deploying the WAR. See Tomcat Configuration for logging, context, environment and HTTPS setup.

Step 3: Deploy the WAR File

Remove application cache if any by removing following directory: $CATALINA_BASE/work/Catalina/localhost/oslc-connect-jira

Then copy the WAR file in: $CATALINA_BASE/webapps/

Step 4: Start Tomcat

Start Tomcat with: $CATALINA_BASE/bin/startup script

Tomcat startup shall be added as a service for starting and stopping (see Windows Service or Linux Services)

Step 5: Verify Deployment

Once Tomcat has started, access the help content at: https://your-server:your-port/oslc-connect-jira/help/ to check the application is started.

As a Jira Administrator, access the application at: https://your-server:your-port/oslc-connect-jira/

Check the logs for any errors: ~/oslc-connect-jira-cloud/logs/broker.log