Skip to main content
This page lists the environment variables of the Mensageria. Plugin SISBAJUD environment variables lists the variables of Plugin SISBAJUD. BYOC configuration essentials documents the variables that every Lerian Go service shares: server, datastores, telemetry, and plugin authentication. In the tables below, the Default / Required column shows the default value. A bold qualifier (for example Required) marks the variables you must set. — means no default. A variable marked Sensitive holds a credential or key material. Inject it from your secret manager at deploy time. Do not commit its value.

Service and runtime

The production checks require POSTGRES_PASSWORD and refuse POSTGRES_SSLMODE=disable. With STREAMING_ENABLED=true, they also require STREAMING_TLS_ENABLED=true.
Unless the Mensageria serves TLS itself (both files set and TLS_TERMINATED_UPSTREAM=false), it reads SHUTDOWN_DRAIN_DELAY and SHUTDOWN_TIMEOUT. BYOC configuration essentials describes the shutdown lifecycle.

Authentication

The boot accepts a missing verification key and a missing issuer only when all three conditions are true: PLUGIN_AUTH_ENABLED is true, DEPLOYMENT_MODE is local or unset, and ENV_NAME is local. The boot refuses a malformed value in an AUTH_* variable, in TRUSTED_PROXIES, in IDP_DECLARATION_ENABLED, or in MULTI_TENANT_ENABLED, and the log names the variable.

License

License Manager describes how the product checks the license. The /readyz response includes a license check. A license file past its expiry and its 14-day grace period stops the service.

Key management

Vault (when KMS_PROVIDER=vault)

AWS KMS (when KMS_PROVIDER=aws)

The two key modes:
  • managed. The Mensageria creates one key for each institution, and kek:rotate rotates it.
  • provided. One key that you create protects every institution. The Mensageria never creates or rotates it, and kek:rotate returns 422. When your key custodian rotates the key, the Mensageria records the new version.
Prepare AWS before the first boot:
  • In provided mode, the key must be symmetric (SYMMETRIC_DEFAULT), with the usage ENCRYPT_DECRYPT, the origin AWS_KMS, and the state Enabled. The Mensageria refuses a key with imported key material.
  • The Mensageria gets its AWS credentials from the default credential chain of the AWS SDK.
  • In both modes, its identity needs kms:DescribeKey, kms:GenerateDataKey, kms:Decrypt, kms:ReEncryptFrom, kms:ReEncryptTo, and kms:ListKeyRotations on its keys. In managed mode, it also needs kms:CreateKey, kms:TagResource, kms:CreateAlias, kms:RotateKeyOnDemand, kms:GetKeyRotationStatus, kms:ListAliases, and tag:GetResources.
  • Each data key call carries the encryption context institution_id and key_purpose. Your key policy can use them in conditions.
Choose the key provider once. When the database holds data that another key provider protects, the boot refuses.

Execution API and sweeper

Plugin SISBAJUD reads orders and reports results through the execution API. Integrating with Lerian SISBAJUD describes it.

Event streaming

Response files and workers

Object storage

Lerian STA consumer

The Mensageria receives remittance files only from the events that Lerian STA publishes. The consumer uses its own broker settings, STA_STREAM_*. It does not read the STREAMING_* variables.

Lerian STA submission

Values that must match Plugin SISBAJUD

  • RESPONSE_DEADLINE_MARGIN. Plugin SISBAJUD reads the same variable. Set the same value on the Mensageria and on Plugin SISBAJUD.
  • Mutual TLS. Plugin SISBAJUD has its own switch, MENSAGERIA_MTLS_ENABLED. Set it to the same value as SISBAJUD_EXECUTION_MTLS_ENABLED. With mutual TLS on the Mensageria and off on Plugin SISBAJUD, the TLS handshake fails.