Riversoft STCP Gemini API

Configuration of the Riversoft® STCP Gemini API, the management REST API for Riversoft STCP Gemini and Riversoft STCP DirectLink.

Create the file from the template:

cd /usr/local/stcpgemini-api/configs
cp example-config.json config.json

Example:

{
  "databases": {
    "config": {
      "type_database": "mysql",
      "host": "db.example.com",
      "port": 3306,
      "user": "<user>",
      "password": "<password>",
      "database_name": "GEMINI_DBConfig"
    },
    "log": {
      "type_database": "mysql",
      "host": "db.example.com",
      "port": 3306,
      "user": "<user>",
      "password": "<password>",
      "database_name": "GEMINI_DBLog"
    }
  },
  "general": {
    "ssl": true,
    "host": "0.0.0.0",
    "port": 33070,
    "cert": "/usr/local/stcp/keystore/certs/stcpweb_local.cer",
    "key": "/usr/local/stcp/keystore/keys/stcpweb_local.key",
    "key_password": "",
    "api_secret": "<strong-secret>",
    "templates_dir": "",
    "rest_name": "RestAPI",
    "database_maintenance": 0,
    "auth_type": "native"
  }
}

databases.config and databases.log point to the databases created during installation.
In general, set the interface (host), the port (port) and the TLS certificate (ssl, cert, key).
api_secret signs the tokens and protects passwords: use a strong, private value. If empty, the API does not start. It is also the password encryption key and must be the same as the ApplConfigPassPhrase/applConfigPassPhrase of the other modules: see Password encryption key.
rest_name must match the name of the API registration (API/Supervision) in the Riversoft Console Portal. The API reads 2FA, password policies, SSO and the supervision nodes from that registration.

Parameters: Riversoft STCP Gemini API.

Riversoft Console Portal