Deployment as WAR / in Tomcat (tC)

Container deployment recommended see Deployment using Container (tC)

Prerequisites

Prerequisites for tia® and kgs Software Components

The WAR packages can be deployed on an application web server like Tomcat, Jetty, JBoss or GlassFish. It is required, that the correct Versions of Java JDK Version and application web server are already set up before installing the tia Core application.

Starting with tia® Core Content Server version 3.0.0, compatible web application server must support Java JDK 17 and Jakarta Servlet 5.0 (e.g. Tomcat 10+).

Installation of tia® Content Server core

Java and Tomcat need to be pre-installed and tia® Content Server core needs to be downloaded. The following steps will show you how to deploy our software.

Step 1:

Choose a desired web application context name and rename the downloaded war file accordingly.

Example:

The downloaded war-file is autodigit-saphttp-webapp-3.5.0.war. The desired URL for accessing the Status UI is: https://1.2.3.4:8443/tiaCore-CS/info.

So the application context name is: tiaCore-CS

And the war-file before deployment needs to be renamed into tiaCore-CS.war.

Step 2:

Configure config location

The Tomcat context file is a XML file with the same name as the web application context (respective the war-file deployed. E.g. tiaCore-CS.xml) and is located in <tomcat installation>/conf/Catalina/localhost directory. For more information see Apache Tomcat documentation: https://tomcat.apache.org/tomcat-10.0-doc/config/context.html.

To access and edit the context file

shut down the app
navigate to <tomcat installation>/conf/Catalina/localhost directory
edit there the file called like the application context name with .xml extension
navigate toC:/Program Files/Apache Software Foundation/Tomcat 10.1/conf
edit there a new folder license and put the license into the folder

take the logback-spring.xml and the repository.cfg and put it into the C:/Program Files/Apache Software Foundation/Tomcat 10.1/conf folder

During the deployment the WAR file will be extracted and the default configuration will be available at /WEB-INF/classes/config/repository.cfg . In the context.xml the location of repository.cfg can be changed.

The folder and file for repository.cfg as well as the key store configuration needs to be readable by tomcat process. Don't put these configuration inside an user folder of another user like your login user! Otherwise the app inside tomcat don't have access permissions and will not start.

Example configuration in context file:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Context>
<Context>
    <Parameter
        name="logging.level.com.software.kgs"
        value="info"
        override="true" />
	<Parameter
        name="logging.config"
        value="C:/Program Files/Apache Software Foundation/Tomcat 10.1/conf/logback-spring.xml"
        override="true" />
    <Parameter
        name="volumecounter.file.counterSender.targetUrl"
        value="https://vcrs.kgs-cloud.de"
        override="true" />
    <Parameter
        name="volumecounter.file.counterSender.isActive"
        value="true"
        override="true" />
    <Parameter
        name="volumecounter.file.counterSender.proxy.uri"
        value=<yourProxyURL>
        override="true" />
    <Parameter
        name="volumecounter.file.counterSender.proxy.user"
        value=<yourProxyUser>
        override="true" />
    <Parameter
        name="volumecounter.file.counterSender.proxy.password"
        value=<yourProxyPassword>
        override="true" />
    <Parameter
		name="configDirectory"
		value="C:/Program Files/Apache Software Foundation/Tomcat 10.1/conf/repository"
        override="true" />
	<Parameter
		name="configFile"
		value="repository.cfg"
        override="true" />
	<Parameter
        name="tia.license.path"
        value="C:/Program Files/Apache Software Foundation/Tomcat 10.1/conf/license"
        override="true" />
	<Parameter
		name="webapp.security.auth.type"
		value="basic"
        override="true" />
	<Parameter
		name="webapp.security.auth.basic.username"
		value="admin"
        override="true" />
	<Parameter
		name="webapp.security.auth.basic.password"
		value="$2a$10$eswhIo8VjEviekZxaq1FLukR7I59dEdHiLE.kGEINbfSjA1cZWjG2"
        override="true" />
</Context>

restart the the Tomcat Service

Step 3:

Choose the tiaCore-CS.war-file and deploy it into the webapps folder

After this step the tomcat should create a folder in its webapps directory as well show the app in the application section of the manager.

Step 4:

Open the Tomcat configuration page and go to “Manager App”.

Verify Installation

Choose the deployed war-file from tomcat manager.

The base URL of the deployed application should forward to the web console, which looks like this: