Versions Compared

Old Version 4

changes.mady.by.user Armin Franke

Saved on

compared with

New Version 5

changes.mady.by.user Armin Franke

Saved on

Key

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

tia Viewer Core supports HTTP or HTTPS communication. It is not possible to have both at the same time.

Secure communication over HTTPS requires a certificate in stored as PKCS12 format. The certificate may be public or self-signed. The file typically stored permanently at host and therefore needs to be mapped into the container.

The following configuration must be made in container environmental variables or in YAML configuration file.

Parent

Parameter

Explanation

server.ssl

key-store-type

Key store format.

Supported are PKCS12 and JKS supported. PKCS12 is preferred.

server.ssl

key-store

Location of the keystore

server.ssl

key-store-password

Password for the keystore

server.ssl

key-alias

Alias for the certificate in the pkcs12 store

server.ssl

enabled

true: Enable HTTPS

Info

As communication is on port configured by server.port parameter (default: 8080), also set this parameter to the port desired for HTTPS (e.g. 8443).

Example

Info

This demonstrates how a self-signed certificate is created using keytool JavaSE utility.

The keystore file is named kgs.p12 and resides at host in directory ./tiaviewer.

The store password in the keytool command is test1234. Choose a secure password instead.

The parameters to be added into the command to start the container are given for docker run command (see also Installation and Updating (Vc)).

  1. Create a keystore with a self signed certificate or skip this step with existing certificate.

Code Block
languagebash
keytool -genkeypair -alias kgs -storepass test1234 -keyalg RSA -keysize 2048 -storetype PKCS12 -keystore kgs.p12 -validity 3650

  1. Edit the command to start the container

Map the file in the container:

Code Block
-v ./tiaviewer/kgs.p12:/application/kgs.p12

Add to environment variables:

Code Block
-e SERVER_SSL_KEYSTORETYPE:PKCS12
-e SERVER_SSL_KEYSTORE:/application/kgs.p12
-e SERVER.SSL.KEYSTORE-PASSWORD:test1234
-e SERVER_SSL_KEYALIAS:kgs
-e SERVER_SSL_ENABLED:true