Referência de parâmetros
Riversoft STCP Gemini API
Arquivo: /usr/local/stcpgemini-api/configs/config.json.
databases.config e databases.log
| Parâmetro | Descrição |
|---|---|
type_database | Tipo de banco de dados (ex.: mysql). |
host | Endereço do servidor de banco de dados. |
port | Porta do banco de dados. |
user | Usuário do banco de dados. |
password | Senha do banco de dados. |
database_name | Nome da base de dados. |
Os campos type_database, host, user, password e database_name aceitam os prefixos env: e file:, para ler o valor de uma variável de ambiente ou de um arquivo, sem deixá-lo no config.json. Exemplo: "password": "env:STCP_DB_PASSWORD".
general
| Parâmetro | Descrição |
|---|---|
ssl | Habilita HTTPS/TLS na API. Com true, exige cert e key válidos. |
host | Interface em que a API escuta. 0.0.0.0 escuta em todas as interfaces. |
port | Porta da API (ex.: 33070). |
cert | Certificado TLS, usado quando ssl está habilitado. |
key | Chave privada do certificado. |
key_password | Senha da chave privada, quando houver. |
api_secret | Segredo usado para assinar e validar os tokens e proteger as senhas. Obrigatório: com o valor vazio, a API não inicia. Dado sensível. Deve ser igual nos demais módulos do ambiente. Veja Chave de criptografia das senhas. |
templates_dir | Pasta de templates personalizados. |
rest_name | Nome do cadastro da API (API/Supervisão) no Riversoft Console Portal. Na inicialização, a API carrega o cadastro com esse nome; se ele não existir, a API não inicia. |
database_maintenance | Intervalo, em segundos, da rotina de manutenção do banco. 0 desabilita. |
auth_type | Mecanismo de autenticação. Valor padrão: native (autenticação nativa do STCP). Para login LDAP, o operador informa o usuário no formato domínio/operador. |
webapp_dir | Diretório do Riversoft Console Portal servido no modo -lite. Tem prioridade sobre a opção -webapp. |
sso_login_redirect | URL de retorno após o login SSO. Se omitido, usa o valor do cadastro da API. |
sso_logout_end_session | true encerra também a sessão no provedor de identidade no logout. |
session_duration | Validade dos tokens emitidos, em minutos. Padrão 60; máximo 720 (12 horas). |
appl_serialnumber | Número de série da licença. |
appl_license | Chave da licença. Dado sensível. |
Os campos host, port, cert, key e key_password não informados no config.json são lidos do cadastro da API no banco.
A API verifica o número de série e a licença na inicialização: se forem inválidos, ela não inicia. Quando a licença vence, a API é encerrada. A situação da licença pode ser consultada em GET /info/license.
A 2FA dos operadores é habilitada no cadastro da API. A variável de ambiente DIRLMFA, com qualquer valor, também habilita a 2FA, mesmo com o cadastro desabilitado.
Riversoft Console Portal
Arquivo: /usr/local/stcpgemini-api/portal/app/configs/config.json.
| Parâmetro | Descrição |
|---|---|
EntryPoint[].name | Nome do ambiente exibido no Portal. |
EntryPoint[].address | Endereço da Riversoft STCP Gemini API, no formato esquema://host:porta (ex.: https://portal.exemplo.com.br:33070). |
defaultLanguage | Idioma padrão da interface (ex.: pt). |
Riversoft STCP Gemini Server
Arquivo: /usr/local/stcp/configs/stcpserver.config.json.
STCPCore
| Parâmetro | Descrição |
|---|---|
ApplName | Nome da instância executada, igual ao cadastrado no Portal. |
ApplDescription | Descrição da instância. |
ApplUser | Usuário do sistema operacional da aplicação. |
ApplGroup | Grupo do sistema operacional da aplicação. |
ApplDir | Diretório da aplicação. |
ApplLockDir | Diretório de controle de lock. |
ApplPidFile | Arquivo com o número do processo (PID). |
ApplUmask | Máscara de permissão para criação de arquivos e diretórios. |
ApplDaemon | Execução em modo daemon. Use sempre "0". |
ApplMsgFileName | Arquivo de mensagens da aplicação. |
ApplMsgLanguage | Idioma das mensagens (ex.: ptb). |
ApplConfigPassPhrase | Frase usada na criptografia das senhas. Dado sensível. Deve ser igual nos demais módulos do ambiente. Veja Chave de criptografia das senhas. |
ApplDebug | Nível de debug para apuração de erros. |
ApplMaximunConsoleMsgs | Número máximo de mensagens exibidas no console. |
ApplMaximunAsyncProcesses | Número máximo de processos simultâneos. |
STCPCfg
| Parâmetro | Descrição |
|---|---|
DLLName | Biblioteca de acesso à configuração, conforme o SGBD: libstcpcfgodbc.so (Microsoft SQL Server), libstcpcfgoracle.so (Oracle Database) ou libstcpcfgmysql.so (MySQL e MariaDB). |
DBName | Nome do banco de configuração. |
DBHost | Endereço do servidor de banco de dados. |
DBPort | Porta do banco de dados. |
DBUser | Usuário do banco de dados. |
DBPswd | Senha do banco de dados. |
MaxConfigTxt | Tamanho máximo, em bytes, do campo de configuração. |
MaxExtraTxt | Tamanho máximo, em bytes, do campo extra. |