> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Variáveis de ambiente

> Variáveis de ambiente distintivas do Lerian Consignado — Dataprev — os adaptadores de integração com a Dataprev e o store de custódia de credenciais por tenant.

O Lerian Consignado — Dataprev é o gateway de propriedade da Lerian que integra fluxos de crédito consignado com a Dataprev. Essas variáveis são definidas no momento do deploy e exigem uma reinicialização do serviço para entrar em vigor. O backbone universal que todo serviço Go da Lerian compartilha — servidor, datastores, multi-tenancy, telemetria, autenticação de plugin e licenciamento — é documentado uma única vez na [referência de configuração BYOC](/pt/reference/byoc-configuration); esta página cobre apenas as variáveis distintivas do Lerian Consignado.

Nas tabelas abaixo, a coluna **Padrão / Obrigatória** mostra o valor padrão; um qualificador em negrito (ex: **Obrigatória**, **Obrigatória em deployments gerenciados**) marca variáveis que devem ser definidas. `—` significa que não há padrão. Qualquer variável marcada como **Sensível** carrega material de credencial ou de chave — injete-a a partir do seu gerenciador de segredos no momento do deploy e nunca faça commit de um valor.

## Serviço e runtime

| Variável              | Padrão / Obrigatória | Descrição                                                                                                                                                                                                             |
| --------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SERVER_ADDRESS`      | `:8080`              | Endereço de escuta HTTP principal. As probes de liveness, readiness, metrics e version se vinculam a essa mesma porta.                                                                                                |
| `ENVIRONMENT_NAME`    | `staging`            | Ambiente de runtime: `staging` ou `production`. Arma controles de segurança mais estritos em `production`. `ENV_NAME` é aceito como nome alternativo.                                                                 |
| `SYSTEMPLANE_ENABLED` | `false`              | Habilita a API de administração de configuração de runtime do [Systemplane](/pt/reference/systemplane/overview) sob o prefixo `/system` na porta principal. Desligada por padrão (modo apenas variáveis de ambiente). |
| `DEFAULT_TENANT_ID`   | `default`            | Identificador de tenant usado no modo single-tenant.                                                                                                                                                                  |

<Note>
  O Lerian Consignado expõe `/health` (liveness) e `/readyz` (readiness) na porta principal, além de `/version` e `/metrics`, e — quando a multi-tenancy está habilitada — `GET /readyz/tenant/{id}`. Consulte [Saúde e prontidão](/pt/reference/health-and-readiness) para o contrato das probes.
</Note>

## Integração com a Dataprev

Cada fluxo da Dataprev é controlado por seu próprio switch e seleciona um adaptador. `disabled` e os adaptadores fake locais são apenas para desenvolvimento; um deployment gerenciado provisiona o adaptador real e suas credenciais por tenant através do store de custódia abaixo.

| Variável                                    | Padrão / Obrigatória | Descrição                                                                                                                                                          |
| ------------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `DATAPREV_AVERBACAO_ENABLED`                | `false`              | Opt-in independente para a money path de averbação (consumo de margem). A averbação permanece não inscrita a menos que isso seja habilitado junto com o streaming. |
| `DATAPREV_EMPLOYMENT_REPORT_ENABLED`        | `false`              | Habilita o fluxo de relatório de situação de emprego.                                                                                                              |
| `DATAPREV_EMPLOYMENT_REPORT_ADAPTER`        | `disabled`           | Adaptador do relatório de emprego. `disabled` é o padrão no-op.                                                                                                    |
| `DATAPREV_EMPLOYMENT_REPORT_INTERVAL_SEC`   | `3600`               | Cadência de polling do relatório de emprego, em segundos.                                                                                                          |
| `DATAPREV_EMPLOYMENT_REPORT_PAGE_SIZE`      | `100`                | Registros lidos por página de relatório de emprego.                                                                                                                |
| `DATAPREV_EMPLOYMENT_REPORT_CONCURRENCY`    | `4`                  | Workers concorrentes de relatório de emprego.                                                                                                                      |
| `DATAPREV_EXCLUSION_ENABLED`                | `false`              | Habilita o fluxo de exclusão.                                                                                                                                      |
| `DATAPREV_EXCLUSION_ADAPTER`                | `disabled`           | Adaptador de exclusão. `disabled` é o padrão no-op.                                                                                                                |
| `DATAPREV_EXCLUSION_PROVIDER_TIMEOUT_SEC`   | `30`                 | Timeout por requisição, em segundos, para chamadas ao provider de exclusão.                                                                                        |
| `DATAPREV_EXCLUSION_CLAIM_DWELL_SEC`        | `60`                 | Espera antes de um item de exclusão reivindicado ser reprocessado.                                                                                                 |
| `DATAPREV_EXCLUSION_STATUS_CHECK_LEASE_SEC` | `60`                 | Lease para o worker de verificação de status de exclusão.                                                                                                          |
| `DATAPREV_EXCLUSION_RECOVERY_INTERVAL_SEC`  | `30`                 | Cadência da varredura de recuperação de exclusão, em segundos.                                                                                                     |
| `DATAPREV_EXCLUSION_RECOVERY_BATCH`         | `50`                 | Itens de exclusão processados por passada de recuperação.                                                                                                          |
| `DATAPREV_EXCLUSION_RECOVERY_CONCURRENCY`   | `4`                  | Workers concorrentes de recuperação de exclusão.                                                                                                                   |
| `DATAPREV_REDIRECTION_ADAPTER`              | `disabled`           | Adaptador de redirecionamento. `disabled` é o padrão no-op.                                                                                                        |

## Custódia de credenciais

As credenciais de certificado e OAuth da Dataprev por tenant são custodiadas através de um secret store gerenciado. Deployments gerenciados devem habilitá-lo — o boot guard se recusa a iniciar um deployment gerenciado enquanto ele estiver desligado.

| Variável                                      | Padrão / Obrigatória                                 | Descrição                                                                                                                                                                                          |
| --------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `CREDENTIALS_STORE_ENABLED`                   | `false` · **Obrigatória em deployments gerenciados** | Habilita o store de custódia de credenciais por tenant. Deve ser `true` em deployments de produção, multi-tenant, SaaS ou BYOC; um deployment gerenciado se recusa a iniciar enquanto for `false`. |
| `CREDENTIALS_CLEANUP_INTERVAL_SEC`            | `30`                                                 | Cadência da varredura de limpeza de credenciais, em segundos.                                                                                                                                      |
| `CREDENTIALS_CLEANUP_BATCH_SIZE`              | `50`                                                 | Credenciais processadas por passada de limpeza.                                                                                                                                                    |
| `CREDENTIALS_CLEANUP_CONCURRENCY`             | `4`                                                  | Workers concorrentes de limpeza de credenciais.                                                                                                                                                    |
| `CREDENTIALS_CLEANUP_LEASE_SEC`               | `60`                                                 | Lease para o worker de limpeza de credenciais.                                                                                                                                                     |
| `CREDENTIALS_CLEANUP_PERSISTENCE_TIMEOUT_SEC` | `5`                                                  | Timeout de persistência por operação, em segundos.                                                                                                                                                 |
| `AWS_REGION`                                  | `us-east-1`                                          | Região para o backend de custódia do secrets-manager. As credenciais são resolvidas através da cadeia padrão do AWS SDK.                                                                           |
| `AWS_ENDPOINT_URL`                            | —                                                    | Override de endpoint compatível com AWS para desenvolvimento local. Deixe não definido em ambientes AWS reais; produção não deve defini-lo.                                                        |
