Configuration

Overview

Each component has its own configuration file, created from a template installed with the package:

Component	File	Template
Riversoft STCP Gemini API	`/usr/local/stcpgemini-api/configs/config.json`	`example-config.json`
Riversoft Console Portal	`/usr/local/stcpgemini-api/portal/app/configs/config.json`	`example-config.json`
Riversoft STCP Gemini Server	`/usr/local/stcp/configs/stcpserver.config.json`	`example-stcpserver.config.json`

The parameters of each file are described in the Parameter reference.

Warning

The files contain database passwords, keys and secrets. Replace every sample value, restrict access to the service user and group, and do not version files that contain secrets.

Riversoft STCP Gemini API

Riversoft STCP Gemini API config.json file: HTTP server, TLS and databases.

Riversoft Console Portal

Riversoft Console Portal config.json file: API address and multiple environments.

Riversoft STCP Gemini Server

Riversoft STCP Gemini Server stcpserver.config.json file: instance, configuration database and access library.

Password encryption key

Passwords and other sensitive data stored in the configuration database (for example, the passwords of users, databases and supervision credentials) are encrypted. All modules that read or write this data must use the same key. Otherwise, a module cannot read the passwords stored by another one.

Module	File	Parameter
Riversoft STCP Gemini Server	`/usr/local/stcp/configs/stcpserver.config.json`	`ApplConfigPassPhrase` (`STCPCore` section)
Riversoft STCP DirectLink	`configs/config.json` of the installation	`applConfigPassPhrase`
Riversoft STCP Gemini Rename	`/usr/local/stcpren/configs/config.json`	`applConfigPassPhrase` (`General` section)
Riversoft STCP Gemini API	`/usr/local/stcpgemini-api/configs/config.json`	`api_secret` (`general` section)

    flowchart LR
    K[Same key] --> G[Gemini Server]
    K --> D[DirectLink]
    K --> R[Gemini Rename]
    K --> A[Gemini API]
    G --> DB[(Configuration database<br/>encrypted passwords)]
    D --> DB
    R --> DB
    A --> DB

Important

Set the key before the first registration and use the same value in all modules of the environment. To change it later, the sensitive data already stored must be encrypted again with the new key, through a procedure performed with a dedicated application. Contact Riversoft support before changing the key.

Use a strong, random value, kept out of the code.
In Riversoft STCP DirectLink, the parameter accepts a secret reference (env:, file: or kms:). Prefer to read the value from an environment variable, a protected file or a secrets vault.
In Riversoft STCP Gemini API, api_secret also signs the access tokens.
Keep the key in the environment’s secure backup: without it, the passwords of a restored database cannot be read.

Next steps

Start the services: Operation.
Create the instance and change the administrator operator (stcpadmin) password: Administration.