Versions Compared

Old Version 18

changes.mady.by.user Peter Schwigon

Saved on

compared with

New Version Current

changes.mady.by.user Benjamin Schröder

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Container deployment is recommended see : Deployment using Container (tC)

WAR packages for deployment of tia® Core are stored at https://download.kgs-software.com/?login

Info

An account is required. It is provided for licensed installations via kgs Customer Support https://kgs-software.atlassian.net/servicedesk/customer/portal/2/group/2/create/19

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 version of Java JDK Version and application web server are is 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:

Web Application Context Name

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

Example:

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

So Then the application context name is: tiaCore-CS

And To achieve this, the .war -file before deployment needs to must be renamed into as follows: tiaCore-CS.war.

Step 2:

...

Configure the configuration location

The Tomcat context file is a an XML file with the same name as the web application context name (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

...

Best practice:

  • Shut down Apache Tomcat

  • Navigate to <tomcat installation>/conf/Catalina/localhost directory

  • edit there the Create a 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

Info

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.

Note

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.

...

  • e.g. tiaCore-CS.xml. The advantage of this procedure is that the web context and the configuration are not overwritten even if the .war file is updated, as long as the name of the .war file remains the same as before the update.

    • Example configuration of the context file e.g tiaCore-CS.xml:

      Code Block
      <?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>

  • Navigate to<tomcat installation>/conf

  • Create a new folder license and put the license into it

  • Take the logback-spring.xml and the repository.cfg and put it into the <tomcat installation>/conf folder

    View file
    namelogback-spring.xml


    View file
    namerepository.cfg

Info

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

Note

The folder and file for repository.cfg as well as a key store configuration, if any, needs to be readable by tomcat process. Don't put these configuration inside a user folder of another user like your login user! otherwise the webapp within tomcat does not have the access permission and will not start.

  • restart the the Tomcat Service

...

WAR file deployment

Choose the tiaCore-CS.war -file and deploy it into the webapps folder of the Apache Tomcat installation:

...

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

grafik-20240702-151404.pngImage ModifiedStep 4:

Apache Tomcat Manager App

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

...

Verify Installation

Apache Tomcat Manager App

Choose the deployed .war - file from tomcat manager e. g. /tiaCore-CS.


...

  • The base URL of the deployed application should forward to the web console, which looks like thissuccessfully installed tiaCore-CS now presents the UI of tia core:

grafik-20240702-152017.png