Parameter reference
Riversoft STCP Gemini API
File: /usr/local/stcpgemini-api/configs/config.json.
databases.config and databases.log
| Parameter | Description |
|---|---|
type_database | Database type (e.g. mysql). |
host | Database server address. |
port | Database port. |
user | Database user. |
password | Database password. |
database_name | Database name. |
The type_database, host, user, password and database_name fields accept the env: and file: prefixes, to read the value from an environment variable or a file instead of keeping it in config.json. Example: "password": "env:STCP_DB_PASSWORD".
general
| Parameter | Description |
|---|---|
ssl | Enables HTTPS/TLS on the API. With true, requires valid cert and key. |
host | Interface on which the API listens. 0.0.0.0 listens on all interfaces. |
port | API port (e.g. 33070). |
cert | TLS certificate, used when ssl is enabled. |
key | Certificate private key. |
key_password | Private key password, if any. |
api_secret | Secret used to sign and validate tokens and protect passwords. Required: if empty, the API does not start. Sensitive data. Must be the same in the other modules of the environment. See Password encryption key. |
templates_dir | Custom templates folder. |
rest_name | Name of the API registration (API/Supervision) in the Riversoft Console Portal. At startup, the API loads the registration with this name; if it does not exist, the API does not start. |
database_maintenance | Interval, in seconds, of the database maintenance routine. 0 disables it. |
auth_type | Authentication mechanism. Default value: native (native STCP authentication). For LDAP sign-in, the operator enters the user in the domain/operator format. |
webapp_dir | Riversoft Console Portal directory served in -lite mode. Takes precedence over the -webapp option. |
sso_login_redirect | Return URL after SSO sign-in. If omitted, uses the API registration value. |
sso_logout_end_session | true also ends the session at the identity provider on sign-out. |
session_duration | Validity of the issued tokens, in minutes. Default 60; maximum 720 (12 hours). |
appl_serialnumber | License serial number. |
appl_license | License key. Sensitive data. |
The host, port, cert, key and key_password fields not set in config.json are read from the API registration in the database.
The API checks the serial number and the license at startup: if they are invalid, it does not start. When the license expires, the API shuts down. The license status is available at GET /info/license.
Operator 2FA is enabled in the API registration. The DIRLMFA environment variable, with any value, also enables 2FA, even when it is disabled in the registration.
Riversoft Console Portal
File: /usr/local/stcpgemini-api/portal/app/configs/config.json.
| Parameter | Description |
|---|---|
EntryPoint[].name | Environment name shown in the Portal. |
EntryPoint[].address | Riversoft STCP Gemini API address, in the scheme://host:port format (e.g. https://portal.example.com:33070). |
defaultLanguage | Default interface language (e.g. pt). |
Riversoft STCP Gemini Server
File: /usr/local/stcp/configs/stcpserver.config.json.
STCPCore
| Parameter | Description |
|---|---|
ApplName | Name of the instance run, the same as registered in the Portal. |
ApplDescription | Instance description. |
ApplUser | Operating system user of the application. |
ApplGroup | Operating system group of the application. |
ApplDir | Application directory. |
ApplLockDir | Lock control directory. |
ApplPidFile | File with the process number (PID). |
ApplUmask | Permission mask for creating files and directories. |
ApplDaemon | Daemon mode execution. Always use "0". |
ApplMsgFileName | Application messages file. |
ApplMsgLanguage | Message language (e.g. ptb). |
ApplConfigPassPhrase | Passphrase used to encrypt passwords. Sensitive data. Must be the same in the other modules of the environment. See Password encryption key. |
ApplDebug | Debug level for troubleshooting. |
ApplMaximunConsoleMsgs | Maximum number of messages shown on the console. |
ApplMaximunAsyncProcesses | Maximum number of simultaneous processes. |
STCPCfg
| Parameter | Description |
|---|---|
DLLName | Configuration access library, according to the DBMS: libstcpcfgodbc.so (Microsoft SQL Server), libstcpcfgoracle.so (Oracle Database) or libstcpcfgmysql.so (MySQL and MariaDB). |
DBName | Configuration database name. |
DBHost | Database server address. |
DBPort | Database port. |
DBUser | Database user. |
DBPswd | Database password. |
MaxConfigTxt | Maximum size, in bytes, of the configuration field. |
MaxExtraTxt | Maximum size, in bytes, of the extra field. |