Saltar para o conteúdo

Configuração

Visão geral

Cada componente tem o seu arquivo de configuração. A configuração do Riversoft® STCP DirectLink e dos componentes de gestão é criada a partir de um modelo instalado com o pacote:

ComponenteArquivoModelo
Riversoft STCP Gemini API/usr/local/stcpgemini-api/configs/config.jsonexample-config.json
Riversoft Console Portal/usr/local/stcpgemini-api/portal/app/configs/config.jsonexample-config.json
Riversoft STCP DirectLink/usr/local/stcpdirectlink/configs/config.jsonexample-config.json
Riversoft STCP DirectLink Portal/usr/local/stcpdirectlink/static/portal/assets/configs/config.jsonexample-config.json

Os parâmetros de cada arquivo estão descritos em Referência de parâmetros.

Atenção

Os arquivos contêm senhas de banco, chaves e segredos. Substitua todos os valores de exemplo, restrinja o acesso ao usuário e ao grupo do serviço e não versione os arquivos com segredos.

Chave de criptografia das senhas

As senhas e os demais dados sensíveis gravados no banco de configuração (por exemplo, as senhas dos usuários, dos bancos de dados e das credenciais de supervisão) são criptografados. Todos os módulos que leem ou gravam esses dados precisam usar a mesma chave. Caso contrário, um módulo não consegue ler as senhas gravadas por outro.

MóduloArquivoParâmetro
Riversoft STCP Gemini Server/usr/local/stcp/configs/stcpserver.config.jsonApplConfigPassPhrase (seção STCPCore)
Riversoft STCP DirectLinkconfigs/config.json da instalaçãoapplConfigPassPhrase
Riversoft STCP Gemini Rename/usr/local/stcpren/configs/config.jsonapplConfigPassPhrase (seção General)
Riversoft STCP Gemini API/usr/local/stcpgemini-api/configs/config.jsonapi_secret (seção general)
    flowchart LR
    K[Mesma chave] --> G[Gemini Server]
    K --> D[DirectLink]
    K --> R[Gemini Rename]
    K --> A[Gemini API]
    G --> DB[(Banco de configuração<br/>senhas criptografadas)]
    D --> DB
    R --> DB
    A --> DB
  

Importante

Defina a chave antes do primeiro cadastro e use o mesmo valor em todos os módulos do ambiente. Para trocá-la depois, os dados sensíveis já gravados precisam ser criptografados de novo com a nova chave, por um procedimento feito com uma aplicação própria. Acione o suporte Riversoft antes de trocar a chave.

  • Use um valor forte e aleatório, guardado fora do código.
  • No Riversoft STCP DirectLink, o parâmetro aceita referência a segredo (env:, file: ou kms:). Prefira ler o valor de uma variável de ambiente, de um arquivo protegido ou de um cofre de segredos.
  • Na Riversoft STCP Gemini API, o api_secret também assina os tokens de acesso.
  • Guarde a chave no backup seguro do ambiente: sem ela, as senhas de um banco restaurado não podem ser lidas.

Origens da configuração

Além dos arquivos, o Riversoft STCP DirectLink usa a configuração mantida na instância:

OrigemConteúdo
Arquivo config.jsonConfiguração própria do Riversoft STCP DirectLink: seções General, Kms, Telemetry e Service. Veja Riversoft STCP DirectLink.
Arquivo config.json do Riversoft STCP DirectLink PortalEndereço da API, idioma, aparência, funções e botões de SSO do portal. Veja Riversoft STCP DirectLink Portal.
Banco de configuração da instânciaJWT, SSO e lock externo, administrados no Riversoft Console Portal. Veja Atualização e migração.
Configuração da instânciaUsuários, agendas, diretórios, serviços (endereço, porta e TLS), conectores e parâmetros da API, mantidos no Riversoft Console Portal ou, no Windows, no Riversoft STCP Enterprise Server.

O config.json não substitui a configuração da instância.

Checklist de produção

  • O JSON foi validado com jq empty.
  • A licença existe, é válida e tem permissões restritas.
  • applDir e applLockDir existem e são graváveis pelo usuário do serviço.
  • applSecret e applConfigPassPhrase foram trocados pelos valores reais.
  • applConfigPassPhrase é igual nos demais módulos do ambiente (Riversoft STCP Gemini Server, Riversoft STCP Gemini Rename e api_secret da Riversoft STCP Gemini API). Veja Chave de criptografia das senhas.
  • Senhas e tokens foram substituídos por referências a segredos.
  • O banco de configuração e o banco de log foram testados.
  • A configuração da instância contém os usuários, agendas e diretórios necessários.
  • TLS, host da API e certificados foram configurados no serviço da API.
  • Upload, download, links, notificações e recuperação de senha foram testados.
  • Backup e retenção foram validados antes de habilitar a remoção automática.
  • Telemetria e logs não expõem segredos.
  • Com turnstileEnable ativo, a secret key está protegida e o servidor alcança challenges.cloudflare.com.
  • O processo foi executado em primeiro plano antes da instalação como serviço.
  • O config.json do Riversoft STCP DirectLink Portal aponta url para a API do ambiente e lista apenas provedores SSO configurados na instância.

Próximos passos