Variáveis de ambiente

Defina estas variáveis no momento da implantação. Salvo indicação contrária, alterar uma delas exige reinicialização. A referência de configuração BYOC abrange o runtime compartilhado da Lerian: servidor, datastores, multitenancy, telemetria, autenticação, streaming, outbox e licenciamento. Esta página lista as configurações específicas de Consignado e as poucas configurações compartilhadas que alteram materialmente o comportamento de seu trilho. — significa que não há padrão. Variáveis que carregam certificados, chaves privadas, segredos OAuth ou chaves HMAC são sensíveis e devem vir de um gerenciador de segredos.

Serviço e modo de tenant

Variável	Padrão	Finalidade
`SERVER_ADDRESS`	`:8080`	Listener HTTP principal para a API e as probes.
`ENV_NAME`	`development`	Ativa o endurecimento de produção quando definido como `production`.
`ENVIRONMENT_NAME`	—	Ambiente do listener de eventos multitenant; usa `ENV_NAME` como fallback.
`SYSTEMPLANE_ENABLED`	`false`	Habilita a configuração em tempo de execução em `/system`.
`MULTI_TENANT_ENABLED`	`false`	Seleciona a custódia de credenciais Dataprev por tenant em vez do fallback estático de tenant único.
`DEFAULT_TENANT_ID`	`default`	Tenant usado no modo de tenant único.
`OUTBOX_ENABLED`	`true`	Deve ser `true`; a inicialização recusa um deployment que não consiga registrar os fatos do trilho de forma durável.
`STREAMING_ENABLED`	`true`	Deve ser `true`; o relay de streaming é o único publicador dos fatos do outbox.
`STREAMING_BROKERS`	—	Lista obrigatória de brokers. A inicialização recusa um relay sem destino.
`STREAMING_CLOUDEVENTS_SOURCE`	—	Deve ser exatamente `consignado-gw`. A inicialização recusa qualquer outro valor; uma fonte errada significa que nenhum fato chega a um consumidor.

Cliente e autenticação da Dataprev

Variável	Padrão	Finalidade
`DATAPREV_ENABLED`	`false`	Chave mestra do runtime do trilho Dataprev.
`DATAPREV_BASE_URL`	—	URL base da API principal da Dataprev. HTTPS é obrigatório em implantações gerenciadas; local/dev permite HTTP apenas para hosts de loopback.
`DATAPREV_TOMBAMENTO_BASE_URL`	—	Endpoint separado para operações de tombamento. Vazio mantém essas operações indisponíveis. Segue a mesma política de HTTPS/loopback.
`DATAPREV_OAUTH_TOKEN_URL`	—	Endpoint de token OAuth2. HTTPS é obrigatório em implantações gerenciadas; local/dev permite HTTP apenas para hosts de loopback.
`DATAPREV_OAUTH_CLIENT_ID`	—	Fallback de ID de cliente OAuth para tenant único. Sensível.
`DATAPREV_OAUTH_CLIENT_SECRET`	—	Fallback de segredo de cliente OAuth para tenant único. Sensível.
`DATAPREV_OAUTH_SCOPES`	—	Escopos OAuth delimitados por espaços solicitados à Dataprev.
`DATAPREV_CERT_FILE`	—	Caminho local do certificado ICP-Brasil para desenvolvimento não gerenciado de tenant único. Sensível.
`DATAPREV_KEY_FILE`	—	Caminho da chave privada local associada a `DATAPREV_CERT_FILE`. Sensível.
`DATAPREV_CODIGO_SOLICITANTE`	—	Fallback de código solicitante de três dígitos para o modo de tenant único.
`DATAPREV_REQUEST_TIMEOUT_SEC`	`30`	Timeout para uma requisição à Dataprev.
`DATAPREV_REQUESTS_PER_SECOND`	`25`	Teto de operador validado e padrão do Systemplane para o ritmo do trilho.
`DATAPREV_CONSENT_CACHE_HMAC_KEY`	—	Chave HMAC usada para indexar entradas de cache de consentimento do trabalhador sem expor CPF. Obrigatória quando o trilho usa Redis. Sensível.

Implantações gerenciadas devem usar a custódia de credenciais do tenant. Elas falham fechado, em vez de recorrer a um cliente não autenticado ou sem mTLS.

Janelas de contrato e portabilidade

Variável	Padrão	Finalidade
`DATAPREV_AVERBACAO_ENABLED`	`false`	Habilita o runtime de averbação e o caminho de testemunha de proposta.
`DATAPREV_PORTABILIDADE_SOLICITACAO_WINDOW_HOURS`	`72`	Janela retrospectiva para propostas de portabilidade.
`DATAPREV_PORTABILIDADE_INCLUSAO_GARANTIAS_PATH`	—	Substituição do caminho de envio de garantias de portabilidade à Dataprev.
`DATAPREV_PORTABILIDADE_AVERBACAO_WINDOW_DAYS`	`20`	Janela para concluir o registro de portabilidade de saída.
`DATAPREV_REFINANCIAMENTO_REVERSAO_WINDOW_BUSINESS_DAYS`	`7`	Janela de dias úteis para reversão de refinanciamento.
`DATAPREV_SALDO_DEVEDOR_CLOCK_INTERVAL_SEC`	`86400`	Cadência das obrigações de saldo devedor e fallback de fim de mês.

Feeds de conciliação e emprego

Variável	Padrão	Finalidade
`DATAPREV_RECONCILIATION_ENABLED`	`false`	Habilita a conciliação de escrituração de folha e repasse.
`DATAPREV_RECONCILIATION_INTERVAL_SEC`	`3600`	Cadência de conciliação.
`DATAPREV_RECONCILIATION_LOOKBACK_MONTHS`	`1`	Competências de folha anteriores incluídas em cada passagem.
`DATAPREV_RECONCILIATION_CNPJS`	—	Escopos de empregador separados por vírgula; vazio lê o feed de todo o trilho.
`DATAPREV_RECONCILIATION_TENANT_ID`	—	Tenant usado pelos feeds agendados de tenant único.
`DATAPREV_EMPLOYMENT_REPORT_ENABLED`	`false`	Habilita o feed de desligamento empregatício.
`DATAPREV_EMPLOYMENT_REPORT_ADAPTER`	`disabled`	`dataprev` para o adaptador real; `fake` é somente local.
`DATAPREV_EMPLOYMENT_REPORT_INTERVAL_SEC`	`3600`	Cadência de relatório empregatício.
`DATAPREV_EMPLOYMENT_REPORT_PAGE_SIZE`	`100`	Registros solicitados por página.
`DATAPREV_EMPLOYMENT_REPORT_CONCURRENCY`	`4`	Workers de tenant concorrentes.
`DATAPREV_EMPLOYMENT_REPORT_TENANT_TIMEOUT_SEC`	`300`	Tempo máximo de processamento de um tenant em uma passagem.

Exclusão e redirecionamento

Variável	Padrão	Finalidade
`DATAPREV_EXCLUSION_ENABLED`	`false`	Habilita a admissão e a recuperação de exclusões.
`DATAPREV_EXCLUSION_PROVIDER_TIMEOUT_SEC`	`30`	Timeout de uma chamada ao provedor de exclusão.
`DATAPREV_EXCLUSION_CLAIM_DWELL_SEC`	`60`	Permanência mínima antes que o trabalho reivindicado possa ser tentado novamente.
`DATAPREV_EXCLUSION_STATUS_CHECK_LEASE_SEC`	`60`	Lease para verificações de status de exclusão.
`DATAPREV_EXCLUSION_RECOVERY_INTERVAL_SEC`	`30`	Cadência do ciclo de recuperação.
`DATAPREV_EXCLUSION_RECOVERY_BATCH`	`50`	Operações reivindicadas por passagem.
`DATAPREV_EXCLUSION_RECOVERY_CONCURRENCY`	`4`	Workers de recuperação concorrentes.
`DATAPREV_EXCLUSION_RECOVERY_TENANT_TIMEOUT_SEC`	`60`	Tempo máximo de processamento de um tenant em uma passagem.
`DATAPREV_REDIRECTION_ADAPTER`	`disabled`	Seleção do adaptador de redirecionamento. `fake` é aceito somente para desenvolvimento local.

DATAPREV_EXCLUSION_ADAPTER e DATAPREV_EXCLUSION_FAKE_BASE_URL foram removidos. Remova-os dos manifestos de implantação; valores legados não inertes falham na validação.

Recuperação de desfechos

Um comando do trilho pode terminar com o desfecho não estabelecido: o processo morreu no meio da chamada, ou a Dataprev nunca respondeu. Dois ciclos de recuperação convergem esse estado contra o próprio registro do trilho. Ambos vêm desabilitados por padrão; habilite-os em qualquer deployment que envie averbações ou comandos do trilho, ou um desfecho não estabelecido nunca será resolvido.

Variável	Padrão	Finalidade
`DATAPREV_AVERBACAO_RECOVERY_ENABLED`	`false`	Habilita a convergência de desfechos de averbação.
`DATAPREV_AVERBACAO_RECOVERY_INTERVAL_SEC`	`60`	Cadência de convergência.
`DATAPREV_AVERBACAO_RECOVERY_BATCH`	`50`	Registros reivindicados por passagem.
`DATAPREV_AVERBACAO_RECOVERY_CONCURRENCY`	`4`	Workers de tenant concorrentes.
`DATAPREV_AVERBACAO_RECOVERY_TENANT_TIMEOUT_SEC`	`60`	Tempo máximo de processamento de um tenant em uma passagem.
`DATAPREV_AVERBACAO_RECOVERY_MINIMUM_DWELL_SEC`	`300`	Idade mínima antes que um desfecho não estabelecido seja reconciliado.
`DATAPREV_AVERBACAO_RECOVERY_PROVIDER_TIMEOUT_SEC`	`30`	Timeout de uma leitura do registro.
`DATAPREV_RAIL_COMMAND_RECOVERY_ENABLED`	`false`	Habilita a convergência de refinanciamento, reversão, renegociação e exclusão de portabilidade do lado de origem.
`DATAPREV_RAIL_COMMAND_RECOVERY_INTERVAL_SEC`	`60`	Cadência de convergência.
`DATAPREV_RAIL_COMMAND_RECOVERY_BATCH`	`50`	Registros reivindicados por passagem.
`DATAPREV_RAIL_COMMAND_RECOVERY_CONCURRENCY`	`4`	Workers de tenant concorrentes.
`DATAPREV_RAIL_COMMAND_RECOVERY_TENANT_TIMEOUT_SEC`	`60`	Tempo máximo de processamento de um tenant em uma passagem.
`DATAPREV_RAIL_COMMAND_RECOVERY_MINIMUM_DWELL_SEC`	`300`	Idade mínima antes que um desfecho não estabelecido seja reconciliado.
`DATAPREV_RAIL_COMMAND_RECOVERY_PROVIDER_TIMEOUT_SEC`	`30`	Timeout de uma leitura do registro.

Leilões e lances de clientes

Variável	Padrão	Finalidade
`LEILAO_ENABLED`	`false`	Habilita a descoberta agendada de solicitações de empréstimo abertas.
`LEILAO_CLIENT_BID_ENABLED`	`false`	Habilita a superfície de comandos de lance autenticado do cliente.
`LEILAO_INTERVAL_SEC`	`3600`	Cadência de descoberta de leilões.
`LEILAO_TENANT_ID`	—	Tenant usado pelos fluxos do leilão M001 e da descoberta de portabilidade M011. Obrigatório quando um dos fluxos habilitados precisa dele.
`LEILAO_PORTAL_BASE_URL`	—	Fallback opcional de URL base do portal do trabalhador para tenant único. Deixá-la sem definir é um deployment válido: os lances passam então a viajar com os contatos do próprio cliente. Um valor definido é validado na inicialização, e um valor inseguro faz a inicialização falhar fechada.
`LEILAO_DISCOVERY_LOOKBACK_HOURS`	`8760`	Janela retrospectiva inicial e de recuperação para solicitações abertas.
`LEILAO_DISCOVERY_CLOCK_SKEW_SEC`	`300`	Sobreposição de desvio de relógio aplicada às janelas de descoberta.
`LEILAO_PORTABILITY_ENABLED`	`false`	Habilita a descoberta de portabilidade M011. É independente de `LEILAO_ENABLED`.
`LEILAO_PORTABILITY_INTERVAL_SEC`	`3600`	Cadência da passagem de descoberta de portabilidade M011.
`LEILAO_BID_MANAGER_RPS`	`25`	Orçamento de requisições para o fan-out do gerenciador de lances.
`LEILAO_BID_MANAGER_BURST`	`25`	Orçamento de burst imediato para o fan-out do gerenciador de lances.
`LEILAO_DECIDE_DEADLINE_SEC`	`5`	Prazo de decisão por gerenciador de lances.

A descoberta de portabilidade M011 requer LEILAO_PORTABILITY_ENABLED=true, LEILAO_TENANT_ID, DATAPREV_ENABLED=true, STREAMING_ENABLED=true, um banco de dados primário e o outbox canônico. Ela não requer LEILAO_ENABLED=true. A janela de listagem de portabilidade é de 72 horas por padrão (DATAPREV_PORTABILIDADE_SOLICITACAO_WINDOW_HOURS); o serviço recusa a inicialização se essa janela não for maior que LEILAO_PORTABILITY_INTERVAL_SEC somado à margem de 300 segundos de LEILAO_DISCOVERY_CLOCK_SKEW_SEC.

Custódia de credenciais e artefatos

Variável	Padrão	Finalidade
`CREDENTIALS_STORE_ENABLED`	`false`	Habilita a custódia de credenciais de tenant. Obrigatória quando o trilho Dataprev é executado em uma implantação gerenciada.
`CREDENTIALS_CLEANUP_INTERVAL_SEC`	`30`	Cadência de limpeza de credenciais.
`CREDENTIALS_CLEANUP_BATCH_SIZE`	`50`	Credenciais reivindicadas por passagem de limpeza.
`CREDENTIALS_CLEANUP_CONCURRENCY`	`4`	Workers de limpeza concorrentes.
`CREDENTIALS_CLEANUP_LEASE_SEC`	`60`	Lease de limpeza.
`CREDENTIALS_CLEANUP_PERSISTENCE_TIMEOUT_SEC`	`5`	Timeout de persistência para uma operação de limpeza.
`AVERBACAO_ARTIFACTS_BUCKET`	—	Bucket privado de object store para CCBs e artefatos do trilho. Obrigatório quando `DATAPREV_AVERBACAO_ENABLED=true`.
`AVERBACAO_ARTIFACTS_ENDPOINT_URL`	—	Substituição de endpoint compatível com S3 para object stores locais ou privados.
`AVERBACAO_ARTIFACTS_USE_PATH_STYLE`	`false`	Usa endereçamento S3 de estilo de caminho quando habilitado.
`AWS_REGION`	—	Região usada pela custódia de credenciais e pelo armazenamento de artefatos. Deliberadamente não tem padrão: um valor não definido deixa o SDK da AWS resolver a região da própria instituição, e um valor fixo a sobrescreveria. Defina-a explicitamente para a região em que seus dados devem permanecer.
`AWS_ENDPOINT_URL`	—	Substituição de endpoint compatível com AWS para desenvolvimento local. Não a defina na produção gerenciada da AWS.

O Consignado não admite um modo de inicialização sem eventos: outbox, streaming e brokers são obrigatórios, embora sejam configurações compartilhadas da plataforma. Mantenha a fonte de CloudEvent fixada em consignado-gw.

​Serviço e modo de tenant

​Cliente e autenticação da Dataprev

​Janelas de contrato e portabilidade

​Feeds de conciliação e emprego

​Exclusão e redirecionamento

​Recuperação de desfechos

​Leilões e lances de clientes

​Custódia de credenciais e artefatos

Serviço e modo de tenant

Cliente e autenticação da Dataprev

Janelas de contrato e portabilidade

Feeds de conciliação e emprego

Exclusão e redirecionamento

Recuperação de desfechos

Leilões e lances de clientes

Custódia de credenciais e artefatos