Variables de entorno

Configura estas variables en el momento del despliegue. A menos que se indique lo contrario, cambiar una requiere un reinicio. La referencia de configuración de BYOC cubre el runtime compartido de Lerian: servidor, almacenes de datos, telemetría, autenticación, streaming, outbox y licenciamiento. Esta página enumera los ajustes específicos de Consignado y los pocos ajustes compartidos que cambian materialmente el comportamiento de este riel. — significa que no hay un valor predeterminado. Las variables que contienen certificados, claves privadas, secretos de OAuth o claves HMAC son sensibles y deben provenir de un gestor de secretos. Un despliegue es gestionado cuando DEPLOYMENT_MODE es byoc o saas, cuando ENV_NAME es production, o cuando MULTI_TENANT_ENABLED es true.

Modo de servicio y tenant

Variable	Predeterminado	Propósito
`SERVER_ADDRESS`	`:8080`	Listener HTTP principal para la API y los probes.
`DEPLOYMENT_MODE`	`local`	`local`, `byoc` o `saas`. El arranque rechaza cualquier otro valor. `byoc` y `saas` hacen que el despliegue sea gestionado.
`ENV_NAME`	`development`	Etiqueta del entorno. `production` hace que el despliegue sea gestionado.
`SYSTEMPLANE_ENABLED`	`false`	Habilita la configuración en tiempo de ejecución bajo `/system`.
`MULTI_TENANT_ENABLED`	`false`	Ejecuta el gateway para varios tenants. `true` hace que el despliegue sea gestionado.
`OUTBOX_ENABLED`	`true`	Debe ser `true`; el arranque rechaza un despliegue que no puede registrar los hechos del riel de forma duradera.
`OUTBOX_RETENTION_PUBLISHED_HOURS`	`1`	Horas que un hecho publicado permanece en el outbox del gateway después de su publicación, de `0` a `87600`. `0` conserva los hechos publicados para siempre. Un hecho no publicado no se elimina nunca.
`STREAMING_ENABLED`	`true`	Debe ser `true`; el relay de streaming es el único publisher de los hechos del outbox.
`STREAMING_BROKERS`	—	Lista de brokers obligatoria. El arranque rechaza un relay sin destino.
`STREAMING_CLOUDEVENTS_SOURCE`	—	Debe ser exactamente `consignado-gw`. El arranque rechaza cualquier otro valor; un source incorrecto significa que ningún hecho llega jamás a un consumidor.
`STREAMING_KAFKA_TLS_ENABLED`	`false`	Conecta con los brokers por TLS. El arranque exige `true`, salvo que `STREAMING_KAFKA_ALLOW_PLAINTEXT` sea `true`.
`STREAMING_KAFKA_ALLOW_PLAINTEXT`	`false`	Permite una conexión sin cifrar con los brokers cuando `ENV_NAME` es `development`, `local` o `test`. Un despliegue gestionado la rechaza.
`STREAMING_KAFKA_SASL_MECHANISM`	—	`plain`, `scram-sha-256` o `scram-sha-512`. Un despliegue gestionado exige uno de los dos valores SCRAM.
`STREAMING_KAFKA_SASL_USERNAME_FILE`	—	Ruta del archivo que contiene el nombre de usuario del broker. Obligatoria con un mecanismo SASL y en un despliegue gestionado.
`STREAMING_KAFKA_SASL_PASSWORD_FILE`	—	Ruta del archivo que contiene la contraseña del broker. Obligatoria con un mecanismo SASL y en un despliegue gestionado. Sensible.
`SUBSCRIPTIONS_HUB_ENABLED`	`false`	Un despliegue gestionado exige `true` y se niega a arrancar sin ella.
`SUBSCRIPTIONS_HUB_BASE_URL`	—	URL base de Streaming Hub. Un despliegue gestionado se niega a arrancar sin ella.

Declaración a Access Manager

La autorización de las solicitudes usa PLUGIN_AUTH_ENABLED (predeterminado true) y PLUGIN_AUTH_HOST, como se describe en Autenticación de plugins. Con la autorización activa, el gateway también publica su manifiesto de permisos en Access Manager durante el arranque. Una publicación fallida detiene el arranque.

Variable	Predeterminado	Propósito
`IDP_DECLARATION_ENABLED`	`true`	Publica el manifiesto de permisos durante el arranque. La publicación exige Access Manager 3.13.0 o posterior. Establécela en `false` cuando el servicio de identidad sea multi-tenant: rechaza la publicación con `501`. `false` omite solo la publicación; la autorización de las solicitudes sigue activa. Con `false`, contacta al soporte de Lerian antes de que el gateway atienda tenants.
`PLUGIN_IDENTITY_ADDRESS`	—	Servicio de identidad que recibe el manifiesto. Se requiere cuando `IDP_DECLARATION_ENABLED` es `true`. Un despliegue gestionado exige `https://`.
`PLUGIN_AUTH_CLIENT_ID`	—	Client ID con el que el gateway publica el manifiesto. Se requiere cuando `IDP_DECLARATION_ENABLED` es `true`.
`PLUGIN_AUTH_CLIENT_SECRET`	—	Client secret de ese client ID. Se requiere cuando `IDP_DECLARATION_ENABLED` es `true`. Sensible.

Cliente de Dataprev y autenticación

Variable	Predeterminado	Propósito
`DATAPREV_ENABLED`	`false`	Interruptor maestro para el runtime del riel de Dataprev.
`DATAPREV_BASE_URL`	—	URL base para la API principal de Dataprev. Se requiere HTTPS en los despliegues gestionados; un despliegue no gestionado permite HTTP solo para hosts loopback.
`DATAPREV_TOMBAMENTO_BASE_URL`	—	Endpoint separado para las operaciones de tombamento. Vacío mantiene esas operaciones no disponibles. Sigue la misma política de HTTPS/loopback.
`DATAPREV_OAUTH_TOKEN_URL`	—	Endpoint de token de OAuth2. Se requiere HTTPS en los despliegues gestionados; un despliegue no gestionado permite HTTP solo para hosts loopback.
`DATAPREV_OAUTH_CLIENT_ID`	—	ID de cliente OAuth. Sensible.
`DATAPREV_OAUTH_CLIENT_SECRET`	—	Secreto de cliente OAuth. Sensible.
`DATAPREV_OAUTH_SCOPES`	—	Ámbitos de OAuth solicitados a Dataprev, separados por comas.
`DATAPREV_CERT_FILE`	—	Ruta local del certificado ICP-Brasil para desarrollo no gestionado. Sensible.
`DATAPREV_KEY_FILE`	—	Ruta local de la clave privada emparejada con `DATAPREV_CERT_FILE`. Sensible.
`DATAPREV_CODIGO_SOLICITANTE`	—	Código de solicitante de tres dígitos.
`DATAPREV_REQUEST_TIMEOUT_SEC`	`30`	Timeout para una solicitud a Dataprev.
`DATAPREV_REQUESTS_PER_SECOND`	`25`	Tasa del riel, de 0 a 25, para las solicitudes que no llevan identidad de tenant. Con Systemplane habilitado, se aplica el valor almacenado en su lugar.
`DATAPREV_CONSENT_CACHE_HMAC_KEY`	—	Clave HMAC para los registros y las entradas de caché de consentimiento del trabajador. Las lecturas de margen y de FGTS del trabajador se rechazan sin ella, y el arranque rechaza un despliegue con Redis sin ella. Sensible.

Los despliegues gestionados deben usar la custodia de credenciales por tenant. Fallan en modo cerrado en lugar de recurrir a un cliente no autenticado o no mTLS.

Ventanas de contrato y portabilidad

Variable	Predeterminado	Propósito
`DATAPREV_AVERBACAO_ENABLED`	`false`	Habilita la averbação, el anexo de CCB y la importación de contratos con sus datos de contabilización. También habilita el almacenamiento de la CCB y de los artefactos del riel, y las correcciones de contrato.
`DATAPREV_PORTABILIDADE_SOLICITACAO_WINDOW_HOURS`	`72`	Ventana retrospectiva para las propuestas de portabilidad.
`DATAPREV_PORTABILIDADE_INCLUSAO_GARANTIAS_PATH`	—	Anulación de la ruta de envío de garantía de portabilidad de Dataprev.
`DATAPREV_PORTABILIDADE_AVERBACAO_WINDOW_DAYS`	`20`	Días corridos, desde la fecha de exclusión de origen que indica la solicitud, para registrar una portabilidad entrante.
`DATAPREV_REFINANCIAMENTO_REVERSAO_WINDOW_BUSINESS_DAYS`	`7`	Ventana en días hábiles para la reversión de refinanciamiento.
`DATAPREV_SALDO_DEVEDOR_CLOCK_INTERVAL_SEC`	`3600`	Cadencia para las obligaciones de saldo devedor y el fallback de fin de mes.
`DATAPREV_SALDO_DEVEDOR_REENVIO_INTERVAL_SEC`	`60`	Cadencia del reenvío de los informes de saldo devedor que un cambio de competencia retuvo.
`CONSIGNADO_DOCUMENTATION_DEADLINE_ENABLED`	`false`	Publica `consignado.averbacao.documentation_deadline` para las averbações que esperan su documentación.
`CONSIGNADO_DOCUMENTATION_DEADLINE_INTERVAL_SEC`	`60`	Cadencia de la verificación del plazo de la documentación.
`DATAPREV_DOCUMENTATION_FOLLOWUP_ENABLED`	`false`	Lee en Dataprev, una vez al día, cada averbação que espera su documentación, desde un día después de la averbação. También lee el nuevo contrato de cada refinanciamiento aceptado a través de este gateway durante 14 días después del resultado. Esto encuentra una reversión hecha en el portal de Dataprev. Requiere `DATAPREV_AVERBACAO_ENABLED=true`.
`DATAPREV_DOCUMENTATION_FOLLOWUP_INTERVAL_SEC`	`300`	Cadencia de la pasada de seguimiento.
`DATAPREV_DOCUMENTATION_FOLLOWUP_CAP_DAYS`	`7`	Días después del instante de vencimiento de la documentación durante los que el seguimiento sigue leyendo un contrato.

Conciliación y feeds de empleo

Variable	Predeterminado	Propósito
`DATAPREV_RECONCILIATION_ENABLED`	`false`	Habilita la contabilidad de nómina y la conciliación de repasse. Cada pasada lee todos los empleadores. Con `MULTI_TENANT_ENABLED=true`, se ejecuta para cada tenant activo y omite un tenant sin credencial de Dataprev almacenada.
`DATAPREV_RECONCILIATION_INTERVAL_SEC`	`3600`	Cadencia de conciliación.
`DATAPREV_RECONCILIATION_LOOKBACK_MONTHS`	`1`	Competencias de nómina anteriores incluidas en cada pasada.
`DATAPREV_EMPLOYMENT_REPORT_ENABLED`	`false`	Habilita el feed de terminación de empleo.
`DATAPREV_EMPLOYMENT_REPORT_ADAPTER`	`disabled`	`dataprev` para el adaptador real; `fake` es solo local.
`DATAPREV_EMPLOYMENT_REPORT_INTERVAL_SEC`	`3600`	Cadencia del informe de empleo.
`DATAPREV_EMPLOYMENT_REPORT_PAGE_SIZE`	`100`	Registros solicitados por página.
`DATAPREV_EMPLOYMENT_REPORT_CONCURRENCY`	`4`	Workers concurrentes por tenant.
`DATAPREV_EMPLOYMENT_REPORT_TENANT_TIMEOUT_SEC`	`300`	Tiempo máximo de procesamiento para un tenant en una pasada.

Exclusión

Variable	Predeterminado	Propósito
`DATAPREV_EXCLUSION_ENABLED`	`false`	Habilita la admisión y recuperación de exclusión.
`DATAPREV_EXCLUSION_PROVIDER_TIMEOUT_SEC`	`30`	Timeout para una llamada al proveedor de exclusión.
`DATAPREV_EXCLUSION_CLAIM_DWELL_SEC`	`60`	Espera mínima antes de que el trabajo reclamado pueda reintentarse.
`DATAPREV_EXCLUSION_STATUS_CHECK_LEASE_SEC`	`60`	Lease para las comprobaciones de estado de exclusión.
`DATAPREV_EXCLUSION_RECOVERY_INTERVAL_SEC`	`30`	Cadencia del bucle de recuperación.
`DATAPREV_EXCLUSION_RECOVERY_BATCH`	`50`	Operaciones reclamadas por pasada.
`DATAPREV_EXCLUSION_RECOVERY_CONCURRENCY`	`4`	Workers concurrentes de recuperación.
`DATAPREV_EXCLUSION_RECOVERY_TENANT_TIMEOUT_SEC`	`60`	Tiempo máximo de procesamiento para un tenant en una pasada.

Deja DATAPREV_EXCLUSION_ADAPTER y DATAPREV_EXCLUSION_FAKE_BASE_URL sin establecer.

Recuperación de resultado

Un comando del riel puede terminar con su resultado sin establecer: el proceso murió a mitad de la llamada, o Dataprev nunca respondió. Dos bucles de recuperación convergen ese estado contra el propio registro del riel. Un tercer bucle reenvía una oferta cuya respuesta del riel se perdió. Los tres bucles están desactivados por defecto. Habilítalos en cualquier despliegue que envíe averbações, comandos del riel, u ofertas. De lo contrario, nada converge automáticamente un resultado sin establecer.

Variable	Predeterminado	Propósito
`DATAPREV_AVERBACAO_RECOVERY_ENABLED`	`false`	Habilita la convergencia de resultado de averbação.
`DATAPREV_AVERBACAO_RECOVERY_INTERVAL_SEC`	`60`	Cadencia de convergencia.
`DATAPREV_AVERBACAO_RECOVERY_BATCH`	`50`	Registros reclamados por pasada.
`DATAPREV_AVERBACAO_RECOVERY_CONCURRENCY`	`4`	Workers concurrentes por tenant.
`DATAPREV_AVERBACAO_RECOVERY_TENANT_TIMEOUT_SEC`	`60`	Tiempo máximo de procesamiento para un tenant en una pasada.
`DATAPREV_AVERBACAO_RECOVERY_MINIMUM_DWELL_SEC`	`300`	Antigüedad mínima antes de conciliar un resultado sin establecer.
`DATAPREV_AVERBACAO_RECOVERY_PROVIDER_TIMEOUT_SEC`	`30`	Timeout para una lectura del registro.
`DATAPREV_RAIL_COMMAND_RECOVERY_ENABLED`	`false`	Habilita la convergencia para el refinanciamiento, la reversión, la renegociación y la exclusión de portabilidad del lado de origen.
`DATAPREV_RAIL_COMMAND_RECOVERY_INTERVAL_SEC`	`60`	Cadencia de convergencia.
`DATAPREV_RAIL_COMMAND_RECOVERY_BATCH`	`50`	Registros reclamados por pasada.
`DATAPREV_RAIL_COMMAND_RECOVERY_CONCURRENCY`	`4`	Workers concurrentes por tenant.
`DATAPREV_RAIL_COMMAND_RECOVERY_TENANT_TIMEOUT_SEC`	`60`	Tiempo máximo de procesamiento para un tenant en una pasada.
`DATAPREV_RAIL_COMMAND_RECOVERY_MINIMUM_DWELL_SEC`	`300`	Antigüedad mínima antes de conciliar un resultado sin establecer.
`DATAPREV_RAIL_COMMAND_RECOVERY_PROVIDER_TIMEOUT_SEC`	`30`	Timeout para una lectura del registro.
`CONSIGNADO_BID_RECONDUCTION_ENABLED`	`false`	Habilita el reenvío de ofertas cuya respuesta del riel se perdió, con el número de propuesta original.
`CONSIGNADO_BID_RECONDUCTION_INTERVAL_SEC`	`15`	Cadencia del reenvío.
`CONSIGNADO_BID_RECONDUCTION_BATCH_SIZE`	`20`	Ofertas reenviadas en una pasada.

Renegociación automática

Estas variables controlan la renegociación automática. Está desactivada por defecto.

Variable	Predeterminado	Propósito
`DATAPREV_AUTO_RENEGOCIACAO_ENABLED`	`false`	Habilita la renegociación automática para los tenants en `DATAPREV_AUTO_RENEGOCIACAO_TENANTS`.
`DATAPREV_AUTO_RENEGOCIACAO_TENANTS`	—	Lista separada por comas de los tenants que la usan. Un UUID de tenant coincide con o sin guiones. Un despliegue single-tenant lista `default`.
`DATAPREV_AUTO_RENEGOCIACAO_INTERVAL_SEC`	`86400`	Cadencia de la pasada.
`DATAPREV_AUTO_RENEGOCIACAO_BATCH`	`50`	Máximo de envíos para un tenant en una pasada. Una pasada envía como máximo una renegociación por cada trabajador.

Con DATAPREV_AUTO_RENEGOCIACAO_ENABLED=true, el arranque rechaza el despliegue a menos que:

DATAPREV_ENABLED sea true
DATAPREV_EMPLOYMENT_REPORT_ENABLED sea true y DATAPREV_EMPLOYMENT_REPORT_ADAPTER sea dataprev
DATAPREV_RAIL_COMMAND_RECOVERY_ENABLED sea true
DATAPREV_AUTO_RENEGOCIACAO_TENANTS nombre al menos un tenant, y cada entrada sea un identificador de tenant válido
DATAPREV_AUTO_RENEGOCIACAO_INTERVAL_SEC y DATAPREV_AUTO_RENEGOCIACAO_BATCH sean positivos

Subastas y ofertas de clientes

Variable	Predeterminado	Propósito
`LEILAO_ENABLED`	`false`	Habilita el descubrimiento programado de solicitudes de préstamo abiertas.
`LEILAO_CLIENT_BID_ENABLED`	`false`	Habilita la superficie de comando de oferta de cliente autenticada.
`LEILAO_INTERVAL_SEC`	`3600`	Cadencia de descubrimiento de subastas.
`LEILAO_TENANT_ID`	—	Con `MULTI_TENANT_ENABLED=true`, el tenant para el que se ejecutan el descubrimiento de subastas y el descubrimiento de portabilidad. Ambos lo requieren en ese modo. Un despliegue single-tenant no lo lee.
`LEILAO_PORTAL_BASE_URL`	—	URL base opcional del portal del trabajador. Dejarla sin establecer es un despliegue válido: las ofertas viajan entonces con los contactos propios del cliente. Un valor establecido se valida en el arranque; uno inseguro hace que el arranque falle en modo cerrado.
`LEILAO_DISCOVERY_LOOKBACK_HOURS`	`48`	Ancho de cada ventana de descubrimiento. Debe ser mayor que `LEILAO_INTERVAL_SEC` más `LEILAO_DISCOVERY_CLOCK_SKEW_SEC`, o el arranque falla.
`LEILAO_DISCOVERY_CLOCK_SKEW_SEC`	`300`	Superposición de desfase de reloj aplicada a las ventanas de descubrimiento. Cada ventana de lectura de la conciliación también termina esa cantidad de segundos antes del reloj del gateway.
`LEILAO_FAST_LANE_ENABLED`	`false`	Habilita una segunda pasada de descubrimiento sobre los últimos 60 segundos de solicitudes abiertas, una vez por segundo por defecto. Solo arranca con `LEILAO_ENABLED=true`.
`LEILAO_PORTABILITY_ENABLED`	`false`	Habilita el descubrimiento de portabilidad. Esto es independiente de `LEILAO_ENABLED`.
`LEILAO_PORTABILITY_INTERVAL_SEC`	`3600`	Cadencia de la pasada de descubrimiento de portabilidad.

El descubrimiento de portabilidad requiere LEILAO_PORTABILITY_ENABLED=true, LEILAO_TENANT_ID en un despliegue multi-tenant, DATAPREV_ENABLED=true, STREAMING_ENABLED=true, una base de datos primaria y el outbox canónico. No requiere LEILAO_ENABLED=true. La ventana de listado de portabilidad es de 72 horas por defecto (DATAPREV_PORTABILIDADE_SOLICITACAO_WINDOW_HOURS). El servicio se niega a arrancar a menos que esa ventana sea más amplia que LEILAO_PORTABILITY_INTERVAL_SEC más el margen de 300 segundos de LEILAO_DISCOVERY_CLOCK_SKEW_SEC.

Custodia de credenciales y artefactos

Variable	Predeterminado	Propósito
`CREDENTIALS_STORE_ENABLED`	`false`	Habilita la custodia de credenciales de Dataprev. Un despliegue gestionado la requiere.
`CREDENTIALS_CLEANUP_INTERVAL_SEC`	`30`	Cadencia de limpieza de credenciales.
`CREDENTIALS_CLEANUP_BATCH_SIZE`	`50`	Credenciales reclamadas por pasada de limpieza.
`CREDENTIALS_CLEANUP_CONCURRENCY`	`4`	Workers concurrentes de limpieza.
`CREDENTIALS_CLEANUP_LEASE_SEC`	`60`	Lease de limpieza.
`CREDENTIALS_CLEANUP_PERSISTENCE_TIMEOUT_SEC`	`5`	Timeout de persistencia para una operación de limpieza.
`AVERBACAO_ARTIFACTS_BUCKET`	—	Bucket privado de almacén de objetos para la CCB y los artefactos del riel. Obligatorio cuando `DATAPREV_AVERBACAO_ENABLED=true`.
`AVERBACAO_ARTIFACTS_ENDPOINT_URL`	—	Anulación de endpoint compatible con S3 para almacenes de objetos locales o privados.
`AVERBACAO_ARTIFACTS_USE_PATH_STYLE`	`false`	Usa direccionamiento S3 de estilo de ruta cuando está habilitado.
`AWS_REGION`	—	Región usada por la custodia de credenciales y el almacenamiento de artefactos. Deliberadamente no tiene valor predeterminado: un valor sin establecer permite que el SDK de AWS resuelva la propia región de la institución, y uno codificado la anularía. Establécela explícitamente para la región en la que deben permanecer tus datos.
`AWS_ENDPOINT_URL`	—	Anulación de endpoint compatible con AWS para el desarrollo local. No la establezcas en producción gestionada de AWS.

Consignado no tiene ningún modo de arranque no orientado a eventos: el outbox, el streaming y los brokers son obligatorios aunque la plataforma comparta esos ajustes. Mantén el source de CloudEvent fijado en consignado-gw.

​Modo de servicio y tenant

​Declaración a Access Manager

​Cliente de Dataprev y autenticación

​Ventanas de contrato y portabilidad

​Conciliación y feeds de empleo

​Exclusión

​Recuperación de resultado

​Renegociación automática

​Subastas y ofertas de clientes

​Custodia de credenciales y artefactos

Modo de servicio y tenant

Declaración a Access Manager

Cliente de Dataprev y autenticación

Ventanas de contrato y portabilidad

Conciliación y feeds de empleo

Exclusión

Recuperación de resultado

Renegociación automática

Subastas y ofertas de clientes

Custodia de credenciales y artefactos