> ## 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.

# Variables de entorno de Console

> Las variables de entorno que conectan Lerian Console con Midaz, Tracer y Access Manager, y las que activan o desactivan pantallas de Console.

Console lee estas variables cuando su contenedor inicia. Después de cambiar una, reinicia el contenedor de Console. No necesitas reconstruir la imagen.

Para instalar o actualizar Console, consulta el [README del chart de Console](https://github.com/LerianStudio/helm/tree/main/charts/product-console).

## Direcciones de los productos

| Variable | Obligatoria | Qué hace |
| :- | :- | :- |
| `MIDAZ_V2_BASE_PATH` | Sí | La dirección de la API `/v2` del Ledger, terminada en `/v2/`. Console lee Fees, Holders, Alias Accounts, rutas contables y rutas de operación desde ella. Sin ella, esas páginas fallan. |
| `TRACER_BASE_PATH` | Solo con Tracer | La dirección del servicio de Tracer, sin `/v1`. |
| `MIDAZ_BASE_PATH` | Sí | La dirección de la API del Ledger para organizaciones, ledgers, assets, cuentas, portafolios, segmentos y tipos de cuenta. Sin ella, estas páginas fallan. |
| `MIDAZ_TRANSACTION_BASE_PATH` | Sí | La dirección de la API del Ledger para transacciones, operaciones y saldos. Sin ella, estas páginas fallan. |
| `FLOWKER_BASE_PATH` | Solo con Flowker | La dirección de la API de Flowker. |
| `REPORTER_BASE_PATH` | Solo con Reporter | La dirección de la API de Reporter. |
| `MATCHER_BASE_PATH` | Solo con Matcher | La dirección de Matcher, sin ruta. |
| `NARYA_BASE_PATH` | Solo con el copilot de Matcher | La dirección del host de Narya que atiende el [copilot de Matcher](https://docs.lerian.studio/es/products/matcher/ui/matcher-copilot.md), sin `/v1`. Sin valor o vacía, el copilot queda desactivado y las páginas de Matcher no muestran el panel. El copilot también necesita `PLUGIN_AUTH_ENABLED` con el valor `true`. |
| `STREAMING_HUB_BASE_PATH` | Solo con Streaming Hub | La dirección de la API de Streaming Hub. |
| `NOTIFICATION_BASE_PATH` | Solo con Notification | La dirección de Notification, sin ruta. |
| `PLUGIN_PIX_INDIRECT_BTG_BASE_PATH` | Solo con Pix BTG | La dirección de Pix BTG, sin ruta. |
| `PLUGIN_PAYMENTS_BASE_PATH` | Solo con Payments | La dirección de la API de Payments. |
| `PLUGIN_BANK_TRANSFER_BASE_PATH` | Solo con Bank Transfer | La dirección de la API de Bank Transfer. |

## Access Manager

| Variable | Valor predeterminado | Qué hace |
| :- | :- | :- |
| `PLUGIN_AUTH_ENABLED` | `true` | Activa el inicio de sesión por medio de Access Manager. Console deriva `NEXT_PUBLIC_PLUGIN_AUTH_ENABLED` de ella cuando esa variable no está definida. Console no arranca a menos que `PLUGIN_AUTH_ENABLED` u `OAUTH_ENABLED` sea `true`. |
| `PLUGIN_AUTH_BASE_PATH` | `http://plugin-auth:4000/v1` | La dirección de la API Auth de Access Manager, terminada en `/v1`. |
| `PLUGIN_AUTH_PUBLIC_BASE_PATH` | — | La dirección de la misma API Auth tal como la alcanza el navegador. Console envía el navegador allí para iniciar un inicio de sesión SSO. Sin ella, Console usa `PLUGIN_AUTH_BASE_PATH`. |
| `PLUGIN_IDENTITY_BASE_PATH` | `http://plugin-identity:4001/v1` | La dirección de la API Identity de Access Manager, terminada en `/v1`. |
| `PLUGIN_AUTH_CLIENT_ID` | — | El client ID de la aplicación de Access Manager con la que Console inicia la sesión de los usuarios. Su secreto es `PLUGIN_AUTH_CLIENT_SECRET`. |

## Opciones de inicio de sesión

| Variable | Predeterminado | Qué hace |
| :- | :- | :- |
| `ENABLE_FORGOT_PASSWORD` | `false` | Activa el restablecimiento de contraseña en la página de inicio de sesión. Está activo solo cuando el valor es `true`. |
| `GOOGLE_DIRECTORY_ENABLED` | `false` | Activa la tarjeta del directorio de Google Workspace en **Configuración** > **Seguridad** > **Single Sign-On**. Está activa solo cuando el valor es `true`. |
| `TRUSTED_PROXIES` | — | Los rangos de direcciones, en formato CIDR y separados por comas, de los proxies delante de Console. Console lee la dirección del llamador en el header de dirección reenviada solo más allá de estos rangos. Sin ella, Console no deriva ninguna dirección de llamador. |
| `ALLOWED_ORIGINS` | — | Los orígenes, separados por comas, desde los que Console acepta solicitudes de escritura, por ejemplo `https://console.example.com`. Sin ella, Console rechaza toda creación, cambio y eliminación. |

## Almacén de datos

Console se conecta a MongoDB con estas variables.

| Variable | Predeterminado | Qué hace |
| :- | :- | :- |
| `MONGODB_URI` | `mongodb` | El esquema de la conexión, por ejemplo `mongodb`. |
| `MONGO_HOST` | `midaz-mongodb` | El host de MongoDB. |
| `MONGO_PORT` | `27017` | El puerto de MongoDB. |
| `MONGODB_DB_NAME` | `midaz-console` | El nombre de la base de datos. |
| `MONGODB_USER` | `midaz` | El usuario de la base de datos. Su contraseña es `MONGODB_PASS`. |
| `MONGO_PARAMETERS` | `directConnection=true` | Las opciones de conexión que Console agrega a la cadena de conexión. |
| `MONGO_TLS_CA_CERT` | — | El certificado de CA de la conexión con MongoDB, como PEM codificado en base64. |
| `MONGO_CONNECT_TIMEOUT` | `30000` | El tiempo, en milisegundos, que Console espera a MongoDB al iniciar. |
| `MONGO_CONNECT_RETRIES` | `5` | El número de intentos de conexión al iniciar. |

## Tipos de cuenta

| Variable | Predeterminado | Qué hace |
| :- | :- | :- |
| `MIDAZ_ACCOUNT_TYPE_VALIDATION_ENABLED` | `false` | Activa la validación de tipo de cuenta en Console. Está activa solo cuando el valor es `true`. |
| `MIDAZ_ACCOUNT_TYPE_VALIDATION` | — | Los pares de organización y ledger, escritos como `<organization-id>:<ledger-id>` y separados por comas. Console omite un par que no tiene esta forma. |

## Telemetría

| Variable | Predeterminado | Qué hace |
| :- | :- | :- |
| `ENABLE_TELEMETRY` | `true` | Activa la exportación de traces, métricas y logs. Está activa solo cuando el valor es `true`. |
| `OTEL_EXPORTER_OTLP_ENDPOINT` | `http://localhost:4318` | La dirección del colector que Console usa para una variable `OTEL_URL_*` vacía. |
| `OTEL_URL_TRACES` | `http://infra:4318/v1/traces` | La dirección de los traces. |
| `OTEL_URL_METRICS` | `http://infra:4318/v1/metrics` | La dirección de las métricas. |
| `OTEL_URL_LOGS` | `http://infra:4318/v1/logs` | La dirección de los logs. |

## Secretos

Guarda `NEXTAUTH_SECRET`, `MONGODB_PASS` y `PLUGIN_AUTH_CLIENT_SECRET` en tu bóveda de secretos. Nunca los pongas en un archivo de tu repositorio ni en una imagen.

## Pantallas

| Variable | Qué controla |
| :- | :- |
| `NEXT_PUBLIC_MIDAZ_CONSOLE_AVATAR_ALLOWED_FORMAT` | Los formatos de imagen aceptados para avatares, separados por comas, por ejemplo `jpeg,jpg,png`. |
| `NEXT_PUBLIC_PARTNERS_ENABLED` | La entrada **Partners** de Configuración y la tarjeta **Partners** de la página de inicio. Están activas salvo que el valor sea `false`. |
| `NEXT_PUBLIC_BANK_TRANSFER_ENABLED` | Las pantallas de Bank Transfer del módulo Midaz. Están desactivadas salvo que el valor sea `true`. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.