Variáveis de ambiente do Console

As variáveis de ambiente que ligam o Lerian Console ao Midaz, ao Tracer e ao Access Manager, e as que ligam ou desligam telas do Console.

O Console lê estas variáveis quando o container inicia. Depois de alterar uma delas, reinicie o container do Console. Você não precisa reconstruir a imagem.

Para instalar ou atualizar o Console, consulte o README do chart do Console.

​

Endereços dos produtos

Variável	Obrigatória	O que faz
MIDAZ_V2_BASE_PATH	Sim	O endereço da API /v2 do Ledger, terminando em /v2/. O Console lê Fees, Holders, Alias Accounts, rotas contábeis e rotas de operação por ela. Sem ela, essas páginas falham.
TRACER_BASE_PATH	Só com o Tracer	O endereço do serviço do Tracer, sem /v1.
MIDAZ_BASE_PATH	Sim	O endereço da API do Ledger para organizações, ledgers, assets, contas, portfólios, segmentos e tipos de conta. Sem ela, essas páginas falham.
MIDAZ_TRANSACTION_BASE_PATH	Sim	O endereço da API do Ledger para transações, operações e saldos. Sem ela, essas páginas falham.
FLOWKER_BASE_PATH	Só com o Flowker	O endereço da API do Flowker.
REPORTER_BASE_PATH	Só com o Reporter	O endereço da API do Reporter.
MATCHER_BASE_PATH	Só com o Matcher	O endereço do Matcher, sem caminho.
NARYA_BASE_PATH	Só com o copiloto do Matcher	O endereço do host do Narya que atende o copiloto do Matcher, sem /v1. Sem valor ou vazia, o copiloto fica desligado e as páginas do Matcher não mostram o painel. O copiloto também precisa de PLUGIN_AUTH_ENABLED com o valor true.
STREAMING_HUB_BASE_PATH	Só com o Streaming Hub	O endereço da API do Streaming Hub.
NOTIFICATION_BASE_PATH	Só com o Notification	O endereço do Notification, sem caminho.
PLUGIN_PIX_INDIRECT_BTG_BASE_PATH	Só com o Pix BTG	O endereço do Pix BTG, sem caminho.
PLUGIN_PAYMENTS_BASE_PATH	Só com o Payments	O endereço da API do Payments.
PLUGIN_BANK_TRANSFER_BASE_PATH	Só com o Bank Transfer	O endereço da API do Bank Transfer.

​

Access Manager

Variável	Padrão	O que faz
PLUGIN_AUTH_ENABLED	true	Liga o login pelo Access Manager. O Console deriva NEXT_PUBLIC_PLUGIN_AUTH_ENABLED dela quando essa variável não está definida. O Console não inicia a menos que PLUGIN_AUTH_ENABLED ou OAUTH_ENABLED seja true.
PLUGIN_AUTH_BASE_PATH	http://plugin-auth:4000/v1	O endereço da API Auth do Access Manager, terminando em /v1.
PLUGIN_AUTH_PUBLIC_BASE_PATH	—	O endereço da mesma API Auth como o navegador a alcança. O Console envia o navegador para lá para começar um login SSO. Sem ela, o Console usa PLUGIN_AUTH_BASE_PATH.
PLUGIN_IDENTITY_BASE_PATH	http://plugin-identity:4001/v1	O endereço da API Identity do Access Manager, terminando em /v1.
PLUGIN_AUTH_CLIENT_ID	—	O client ID da aplicação do Access Manager com que o Console faz o login dos usuários. O segredo dela é PLUGIN_AUTH_CLIENT_SECRET.

​

Opções de login

Variável	Padrão	O que faz
ENABLE_FORGOT_PASSWORD	false	Ativa a redefinição de senha na página de login. Fica ativa só quando o valor é true.
GOOGLE_DIRECTORY_ENABLED	false	Ativa o card do diretório do Google Workspace em Configurações > Segurança > Single Sign-On. Fica ativo só quando o valor é true.
TRUSTED_PROXIES	—	As faixas de endereço, em formato CIDR e separadas por vírgula, dos proxies na frente do Console. O Console lê o endereço do chamador no header de endereço encaminhado só além dessas faixas. Sem ela, o Console não deriva endereço de chamador.
ALLOWED_ORIGINS	—	As origens, separadas por vírgula, de onde o Console aceita requisições de escrita, por exemplo https://console.example.com. Sem ela, o Console recusa toda criação, alteração e exclusão.

​

Armazenamento de dados

O Console se conecta ao MongoDB com estas variáveis.

Variável	Padrão	O que faz
MONGODB_URI	mongodb	O esquema da conexão, por exemplo mongodb.
MONGO_HOST	midaz-mongodb	O host do MongoDB.
MONGO_PORT	27017	A porta do MongoDB.
MONGODB_DB_NAME	midaz-console	O nome do banco de dados.
MONGODB_USER	midaz	O usuário do banco de dados. A senha dele é MONGODB_PASS.
MONGO_PARAMETERS	directConnection=true	As opções de conexão que o Console acrescenta à string de conexão.
MONGO_TLS_CA_CERT	—	O certificado de CA da conexão com o MongoDB, como PEM codificado em base64.
MONGO_CONNECT_TIMEOUT	30000	O tempo, em milissegundos, que o Console espera pelo MongoDB na inicialização.
MONGO_CONNECT_RETRIES	5	O número de tentativas de conexão na inicialização.

​

Tipos de conta

Variável	Padrão	O que faz
MIDAZ_ACCOUNT_TYPE_VALIDATION_ENABLED	false	Ativa a validação de tipo de conta no Console. Fica ativa só quando o valor é true.
MIDAZ_ACCOUNT_TYPE_VALIDATION	—	Os pares de organização e ledger, escritos como <organization-id>:<ledger-id> e separados por vírgula. O Console ignora um par que não tem esse formato.

​

Telemetria

Variável	Padrão	O que faz
ENABLE_TELEMETRY	true	Ativa a exportação de traces, métricas e logs. Fica ativa só quando o valor é true.
OTEL_EXPORTER_OTLP_ENDPOINT	http://localhost:4318	O endereço do coletor que o Console usa para uma variável OTEL_URL_* vazia.
OTEL_URL_TRACES	http://infra:4318/v1/traces	O endereço dos traces.
OTEL_URL_METRICS	http://infra:4318/v1/metrics	O endereço das métricas.
OTEL_URL_LOGS	http://infra:4318/v1/logs	O endereço dos logs.

​

Segredos

Guarde NEXTAUTH_SECRET, MONGODB_PASS e PLUGIN_AUTH_CLIENT_SECRET no seu cofre de segredos. Nunca os coloque em um arquivo do seu repositório nem em uma imagem.

​

Telas

Variável	O que controla
NEXT_PUBLIC_MIDAZ_CONSOLE_AVATAR_ALLOWED_FORMAT	Os formatos de imagem aceitos para avatares, separados por vírgula, por exemplo jpeg,jpg,png.
NEXT_PUBLIC_PARTNERS_ENABLED	O item Parceiros de Configurações e o card Parceiros da página inicial. Ficam ligados, a menos que o valor seja false.
NEXT_PUBLIC_BANK_TRANSFER_ENABLED	As telas de Transferência Bancária do módulo Midaz. Ficam desligadas, a menos que o valor seja true.