Advanced Installation

These sections cover more advanced topics of a TISGraph installation.

Throughout this tutorial, the installation path of osgi-runner is called %INSTDIR%, which is typically located under C:\iteg\osgi-runner or C:\kisters\osgi-runner

Encrypting Configuration Values

Configuration values like database passwords or OAuth secrets may be stored in encrypted form.

Initialize Secrets Encryption

Initially, the encryption master has to be initialized by

cd %INSTDIR%\ps1
.\manage-secrets.ps1 -init

Add Secrets

A secret might be added to an encrypted property file by specifying the configuration set name called PID and a key for referencing the secret lateron.

cd %INSTDIR%\ps1
.\manage-secrets.ps1 -add secrets.properties org.clazzes.jdbc.provider tisgraph-db-passwd 'fiooobar123!'

In order to access this secret, you have to use secret::prop:tisgraph-db-passwd inside the org.clazzes.jdbc.provider configuration instead of specifying the plain password.

After adding a secret, you have to restart the osgi-runner service.

Decrypt a Stored Secret

A once encrypted secret might be decrypted again by

cd %INSTDIR%\ps1
.\manage-secrets.ps1 -decrypt db-secrets.properties org.clazzes.jdbc.provider tisgraph-db-passwd

SSH Access to the osgi-runner Console

In order to access the osgi-runner console for watching individual errors, you might create an SSH key and add to the list of authorized keys.

Generate SSH Keys

If you have installed the SSH client component of your Window Server, you can create an SSH key:

ssh-keygen

The key is generated in %USERPROFILE%\.ssh\id_rsa, the corresponding private key stored in %USERPROFILE%\.ssh\id_rsa.pub.

Install the Public SSH Key to osgi-runner

The so-generated ssh key must be copied to the osgi-runner installation.

cd %INSTDIR%\etc\ssh.d
copy `%USERPROFILE%\.ssh\id_rsa.pub authorized_keys

If you have more than one authorized ssh key, authorized_keys must be set up to contain multiple lines with an ssh public key on each line.

Connect to the osgi-runner Console

Once the ssh key has been set up and authorized, call

cd %INSTDIR%\ps1
.\osgi-shell.ps1

The osgi-runner toplevel installation folder contains a shortcut called osgi-shell, which might be double-clicked instead.