/
Installation tia® Connect (SPC)

Installation tia® Connect (SPC)

tia® Connect is delivered as a container image following Open Container Initiative (OCI) standard. Therefore prerequirement for deploying and running tia® Connect is a container runtime environment supporting OCI standard.

tia® Connect Sharepoint is typically deployed as Azure Container App.

For simplicity reasons, the example below is for docker container runtime.

 

Prepare image registry for container runtime

Images for deployment of tia Core are stored at https://images.kgs-cloud.de. Setup this link as image hub in the choosen container runtime.

An account is required. It is provided for licensed installations via kgs Customer Support.

Images that are no longer supported will be removed without further notice.

Example: Setting up login for docker container runtime

Execute this command to tell docker about the image hub.

docker login https://images.kgs-cloud.de

Docker will prompt for user and password.

 

Deploying tia® Connect container

Pulling tia® Connect image

Load the image from the image hub into the image repository of the container runtime.

Example: Pulling tia® Connect image for docker

docker pull images.kgs-cloud.de/tia-sharepoint/oidc:<version>

Use the version as image tag. The tag latest is not available for images of tia® Connect Sharepoint product.

 

Run tia® Connect image

This demonstrates simply how to run tia® Connect without further configuration.

Docker Parameter

Description

Docker Parameter

Description

--name

Sets a unique name for the container instance.

-p

Port mapping from container to host port. Without port mapping, tia® Connect cannot be communicate to.

The container port is set by server.port parameter (default: 8080).

-v

By volume mapping, directories or files of the residing in hosts file system are mapped to the container file system. Directories/files on host are permanent and survive the lifetime of the container instance.

Volume mappings required:

  • the configuration file connect.yaml. The volume mapping must match with the environment variable SPRING_CONFIG_ADDITIONALLOCATION (see below).

-d

Runs container detached in the background.

-e

Sets an environment variable in the container started.

The environment variable SPRING_CONFIG_ADDITIONALLOCATION has to be set to the connect.yaml file when starting the container.

Finally, the image name of tia® Connect is to specify.

 

Example: Running tia®Connect by docker run command

docker run --name <name> -p <host port>:<container port> -e SPRING_CONFIG_ADDITIONALLOCATION=/app/config/connect.yaml -v <config folder>/connect.yaml:/app/config/connect.yaml -v <license folder>:/application/config/license/ -d images.kgs-cloud.de/tia-sharepoint/oidc:<version>

 

Configuration of HTTPS transport encryption

 

Default communication is HTTP per port 8080.

Read more about configuring HTTPS here: https://kgs-software.atlassian.net/wiki/spaces/DOCUEN/pages/3583541249 .

 

Final considerations

The Microsoft SharePoint instance that tia® Connect integrates with must be able to connect to the tia® Connect instance just set up.

This may be via public internet and requiring secure network configuration. In case of questions ask your network administration team.