Referência de parâmetros
Esta página reúne os parâmetros do arquivo config.json do Riversoft® STCP DirectLink, com tipo e valor padrão. O uso de cada grupo está descrito em Configuração.
Nota
O config.json é lido na inicialização. Depois de alterar qualquer parâmetro, reinicie o serviço. Na coluna Padrão, “—” indica que não há valor padrão.
Transferência e links
Detalhes: Configuração › Transferência e links.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
downloadEnable | booleano | — | Habilita o download. |
downloadExpireDays | inteiro | 1 | Validade do link de download, em dias. 0 usa 24 horas. |
downloadPinExpireSeconds | inteiro | 180 | Validade do PIN de download. Valores até 60 usam 180 segundos; valores maiores são ajustados para múltiplos de 60. |
uploadEnable | booleano | — | Habilita o upload. |
uploadMaxFileSize | inteiro | — | Tamanho máximo aceito no upload, em bytes. |
uploadValidateJSON | booleano | — | Habilita a validação de JSON no fluxo de upload. |
secureLinkPinMaxLen | inteiro | 6 | Tamanho máximo do PIN de link seguro. Valor menor ou igual a zero usa 6. |
secureLinkPinExpireSeconds | inteiro | 180 | Validade do PIN de link seguro. Valores até 60 usam 180 segundos. |
reportMaxLines | inteiro | 100 | Linhas por página do relatório. Valores menores ou iguais a zero ou maiores que 1000 usam 100. |
Detalhes: Configuração › E-mail.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
emailEnable | booleano | — | Habilita as notificações por e-mail. |
emailServerAddress | texto | — | Host do servidor SMTP. |
emailServerPort | inteiro | — | Porta SMTP, por exemplo 587. |
emailAuthUser | texto | — | Usuário SMTP. |
emailAuthPswd | texto | — | Senha SMTP ou referência a segredo. |
emailAuthType | texto | — | Tipo de autenticação aceito pelo provedor. |
emailTemplatesPath | texto | obrigatório com emailEnable | Diretório dos templates de e-mail. Obrigatório quando emailEnable é true. |
emailSendFrom | texto | — | Remetente das mensagens. |
emailReplyTo | texto | — | Endereço do cabeçalho Reply-To. |
emailFormatMimeFrom | texto | — | Formato do cabeçalho From. |
emailSendConfirmationEnable | booleano | — | Envia confirmação após a transferência. |
emailSendConfirmationToSenderEnable | booleano | — | Envia a confirmação também ao remetente. |
emailSendRetryMaximum | inteiro | — | Número máximo de tentativas de envio. |
emailSendRetryWaitSeconds | inteiro | — | Intervalo entre tentativas, em segundos. |
emailCheckValidMXDisable | booleano | — | Desabilita a verificação do registro MX do domínio do destinatário. |
emailProvider | texto | vazio | Provedor de envio de e-mail. Vazio usa SMTP, o único provedor suportado. |
SMS e WhatsApp
Detalhes: Configuração › SMS e WhatsApp.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
smsEnable | booleano | — | Habilita as notificações por SMS ou WhatsApp. |
smsSendConfirmationEnable | booleano | — | Envia confirmação da transferência. |
smsTemplatesPath | texto | obrigatório com smsEnable | Diretório dos templates. Obrigatório quando o recurso está habilitado. |
smsProvider | texto | — | Provedor, por exemplo whatsapp. |
smsEndpoint | texto | — | Endpoint HTTP do provedor. |
smsAuthUser | texto | — | Identificador de autenticação no provedor. |
smsAuthPswd | texto | — | Segredo do provedor ou referência a segredo. |
smsSender | texto | — | Identificador do remetente, como o ID do WhatsApp Business. |
smsSendConfirmationToSenderEnable | booleano | — | Envia ao remetente a confirmação do download feito pelo destinatário, por SMS. |
Roteamento e distribuição
Detalhes: Configuração › Roteamento e distribuição.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
routeEnable | booleano | — | Habilita o roteamento de arquivos. |
routeTableCSVFile | texto | — | Arquivo CSV que relaciona origem, destino e destinatários. |
routeCSVDelimiter | texto | — | Separador do CSV, normalmente ;. |
routeScanTimerMs | inteiro | — | Intervalo de varredura, em milissegundos. |
routeScanSplitFilenameRegex | texto | — | Expressão regular que separa origem e nome do arquivo (grupos origin e filename). |
routeExternalCmdEnable | booleano | — | Habilita um comando externo no roteamento. |
routeExternalCmd | texto | — | Comando externo, com caminho absoluto. |
routeExternalCmdParams | texto | — | Parâmetros do comando externo. |
routePath | lista de textos | — | Diretórios adicionais examinados pelo roteamento. |
routeCopyFileEnable | booleano | — | Copia o arquivo para routeCopyPath. |
routeCopyPath | texto | — | Modelo do caminho de cópia; aceita marcadores como <destination> e <filename>. |
routeDirectLinkEnable | booleano | — | Gera um link do Riversoft STCP DirectLink para o arquivo roteado. |
routeDirectLinkTableIndex | texto | — | Coluna usada para localizar a rota, por exemplo destination. |
routeDirectLinkUrl | texto | — | URL base da API do Riversoft STCP DirectLink. |
routeMoveFileEnable | booleano | — | Move o arquivo para routeMovePath após o processamento. |
routeMovePath | texto | — | Modelo do caminho de backup; aceita <origin>, <filename> e <unixtime>. |
routeRemoveFile | booleano | — | Remove o arquivo original após o processamento. |
Encurtador de URL
Detalhes: Configuração › Encurtador de URL.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
urlShortnerEnable | booleano | — | Habilita o encurtamento de URLs. |
urlShortnerProvider | texto | — | Provedor, por exemplo bitly. |
urlShortnerEndpoint | texto | — | Endpoint da API do provedor. |
urlShortnerToken | texto | — | Token do provedor ou referência a segredo. |
Cloudflare Turnstile
Detalhes: Configuração › Cloudflare Turnstile.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
turnstileEnable | booleano | — | Exige o token Turnstile. Com false, o header é ignorado. |
turnstileSecretKey | texto | obrigatório com turnstileEnable | Secret key do widget ou referência a segredo. Obrigatória quando turnstileEnable é true; sem ela, o serviço não inicia. |
turnstileEndpoint | texto | https://challenges.cloudflare.com/turnstile/v0/siteverify | Endpoint de validação. Altere somente para proxy de saída ou testes. |
turnstileTimeoutSeconds | inteiro | 10 | Tempo máximo da validação. Valores menores ou iguais a 0 usam o padrão. |
Banco de configuração do STCP
Detalhes: Configuração › Banco de configuração do STCP.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
cfgProvider | texto | — | stcpgeminidb para o banco do Riversoft STCP Gemini Server ou stcpwindows para a configuração do Riversoft STCP Enterprise Server. |
cfgInstanceName | texto | — | Nome da instância STCP. |
cfgDbName | texto | — | Nome do banco ou caminho, conforme o provider. Aceita opções de conexão, como as de TLS (veja Requisitos). |
cfgDbHost | texto | — | Host do banco. |
cfgDbPort | inteiro | — | Porta do banco. |
cfgDbUser | texto | — | Usuário do banco. |
cfgDbPswd | texto | — | Senha ou referência a segredo. |
cfgDbType | texto | — | Tipo do banco, por exemplo mysql. |
cfgDbOptions | texto | — | Opções adicionais anexadas ao nome do banco. |
Banco de log
Detalhes: Configuração › Banco de log.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
logDbEnable | booleano | — | Habilita a gravação de logs em banco. |
logDbWindows | booleano | — | Usa o mecanismo de log do Windows, quando aplicável. |
logDbType | texto | — | Tipo do banco de log. |
logDbHost | texto | — | Host do banco de log. |
logDbPort | inteiro | — | Porta do banco de log. |
logDbUser | texto | — | Usuário do banco de log. |
logDbPswd | texto | — | Senha ou referência a segredo. |
logDbName | texto | — | Nome do banco de log. |
Aplicação e segurança
Detalhes: Configuração › Aplicação e segurança.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
applLicense | texto | obrigatório | Caminho do arquivo de licença. O arquivo precisa existir. |
applDir | texto | obrigatório | Diretório absoluto da instalação. Precisa existir. |
applLockDir | texto | — | Diretório de locks. Precisa existir e ser gravável pelo usuário do serviço. |
applPidFile | texto | obrigatório | Caminho do arquivo PID. |
applConfigPassPhrase | texto | — | Frase usada na proteção de valores da configuração. Aceita referência a segredo. Deve ser igual nos demais módulos do ambiente. Veja Chave de criptografia das senhas. |
applSecret | texto | — | Segredo usado na proteção dos links. Use um valor forte, estável e privado. |
applUser | texto | stcp | Usuário de execução do serviço. Padrão: stcp. |
applGroup | texto | stcp | Grupo de execução do serviço. Padrão: stcp. |
applDebug | inteiro | — | Nível de debug. |
applUmask | texto | 0022 | Umask dos arquivos criados. Padrão: 0022. |
applDebugPath | texto | — | Diretório dos arquivos de debug. A opção -debugPath da linha de comando tem prioridade. |
license | texto | — | Nome antigo de applLicense, aceito por compatibilidade. Use applLicense. |
Telemetria
Detalhes: Configuração › Telemetria.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
enable_traces, enable_logs, enable_metrics | booleano | — | Habilitam a exportação de traces, logs e métricas. |
provider_type | texto | — | Tipo do exporter, por exemplo otlphttp. |
provider_host | texto | — | Host e porta do collector. |
provider_file_path | texto | — | Arquivo usado por exporters baseados em arquivo. |
resource_mode | texto | — | Estratégia de criação dos recursos. |
service_namespace, service_env | texto | — | Namespace e ambiente do serviço (por exemplo, prod). |
connect_timeout, export_timeout | inteiro | — | Timeouts de conexão e de exportação. |
tls_enabled | booleano | — | Habilita TLS para o exporter. |
tls_min_version, tls_max_version | texto | — | Limites de versão TLS. |
tls_public_key_cert_file, tls_private_key_file, tls_private_key_file_pswd | texto | — | Certificado, chave privada e senha do cliente, quando exigidos. |
tls_ca_file | texto | — | CA confiável. |
tls_ciphers | texto | — | Cifras permitidas. |
tls_verify_certs | booleano | — | Valida os certificados. Mantenha true em produção. |
Serviço
Detalhes: Configuração › Serviço.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
serviceName | texto | — | Nome interno usado pelo gerenciador de serviços. |
serviceDescription | texto | — | Descrição do serviço. |
serviceDisplayedName | texto | — | Nome de exibição do serviço. |
Provedor de segredos (Kms)
Detalhes: Configuração › KMS e segredos.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
kmsEnable | booleano | — | Habilita o provedor de segredos. |
kmsType | texto | — | Tipo do provedor: aws:secretmanager, azure:keyvault, gcp:secretmanager ou oci:keyvault. |
kmsName | texto | — | Nome descritivo do provedor. |
kmsRegion | texto | — | Região do serviço (AWS e OCI). |
kmsEndpoint | texto | — | Endereço do cofre (Azure e OCI). |
kmsTenant | texto | — | Tenant (Azure) ou tenancy (OCI). |
kmsVaultId | texto | — | Identificador do cofre (OCI). |
kmsClientId | texto | — | Identificador do cliente ou da conta de serviço. |
kmsClientSecret | texto | — | Segredo do cliente, quando a identidade da carga de trabalho não for usada. |
kmsClientPrivateKey | texto | — | Chave privada do cliente (OCI). |
kmsClientPrivateKeyPswd | texto | — | Senha da chave privada do cliente (OCI). |
kmsClientFingerprint | texto | — | Fingerprint da chave do cliente (OCI). |
KmsClientAccessToken | texto | — | Token de acesso do cliente (GCP). |
kmsConfigFile | texto | — | Arquivo de credenciais (GCP). |
Riversoft STCP DirectLink Portal
Os parâmetros do arquivo de configuração do Riversoft STCP DirectLink Portal estão em Configuração › Riversoft STCP DirectLink Portal.