Skip to main content

Variáveis de ambiente

Este documento lista todas as variáveis de ambiente consumidas pelos componentes do stack Portal — core, dashboard, worker (edge de integrações), worker-automation (edge de automações), SDK e EMQX. Serviços de infraestrutura puros (Postgres, Redis, Directus) ficam fora deste catálogo; aqui aparecem apenas as variáveis usadas pelo Portal para se conectar a eles.
Convenções
  • Obrig.: a aplicação não inicializa (ou o use case falha) sem o valor.
  • Opc.: tem default ou é usado apenas em fluxos específicos.
  • Defaults extraídos de packages/core/src/infrastructure/config/environment.ts e dos próprios módulos consumidores.
  • Exemplos com valores marcados <...> devem ser substituídos por segredos reais. Não use os valores FAKENEWS / from-dev que aparecem no docker-compose.yml de desenvolvimento — são placeholders.

Sumário por componente


1. Database & cache

Conexões do core com Postgres (DB de aplicação), Postgres do EMQX (DB que o broker lê para auth) e Redis. Os bancos em si não fazem parte do produto Portal.

2. MQTT / EMQX

Endereço e credenciais para conexão MQTT pelos diferentes componentes.

3. Autenticação (Logto + M2M)

O worker-automation herda esses M2M creds para obter tokens via Logto OIDC ao chamar a API do core.

4. Pagamentos


5. Edge runtime (worker e worker-automation)

Variáveis que governam como o container do edge se anuncia ao core e onde guarda estado local.
Modo HOME vs CLOUD: HOME usa EDGE_TOKEN + Bearer auth e roda em casa do usuário; CLOUD usa shared secret e se auto-registra na frota compartilhada. Exatamente uma das duas envs deve estar setada.

6. Integrações — credenciais OAuth/API

Estas envs habilitam apenas o fluxo de configuração das integrações; as credenciais de cada usuário ficam em config_entries/tokens no banco.

7. Serviços externos

Endpoints e tokens para serviços de terceiros usados pelo core.

8. LLMs

Provedores de modelos de linguagem usados pelo assistente.

9. Misc / SDK


Apêndice — Modos do edge

HOME edge (roda na casa do usuário, atendendo apenas a org dele):
Para automation home edge, troque EDGE_TOKEN por AUTOMATION_EDGE_TOKEN. CLOUD edge (frota compartilhada, atendendo várias orgs):
Para automation cloud edge, troque PORTAL_CLOUD_EDGE_SECRET por PORTAL_CLOUD_AUTOMATION_SECRET. EDGE_QUEUE_PATH em cloud edges é geralmente omitido — os containers são efêmeros, e o buffer em memória de 10.000 mensagens é suficiente para drenar reconexões rápidas.