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.
Esta referência lista todas as variáveis de ambiente usadas pelo Flowker. Variáveis marcadas como obrigatórias causarão falha na inicialização do servidor se não forem definidas.
Servidor
| Variável | Descrição | Padrão | Obrigatória |
|---|
ENV_NAME | Nome do ambiente (dev/staging/production) | development | Não |
SERVER_ADDRESS | Endereço de bind do servidor | :4021 | Não |
CORS_ALLOWED_ORIGINS | Origens CORS permitidas | * | Não |
Autenticação
| Variável | Descrição | Padrão | Obrigatória |
|---|
API_KEY | Chave de API para autenticação via header X-API-Key | — | Sim (se API_KEY_ENABLED=true) |
API_KEY_ENABLED | Habilitar autenticação por chave de API | false | Não |
PLUGIN_AUTH_ENABLED | Habilitar autenticação via plugin do Access Manager como alternativa à API Key | false | Não |
PLUGIN_AUTH_ADDRESS | Endereço gRPC do serviço Access Manager | — | Sim (se PLUGIN_AUTH_ENABLED=true) |
Banco de dados (MongoDB)
| Variável | Descrição | Padrão | Obrigatória |
|---|
MONGO_URI | URI de conexão do MongoDB | — | Sim |
MONGO_DB_NAME | Nome do banco de dados MongoDB | flowker | Não |
MONGO_TLS_CA_CERT | Certificado CA em PEM codificado em Base64 para conexões TLS (ex: AWS DocumentDB) | — | Não |
MONGO_MAX_POOL_SIZE | Tamanho máximo do pool de conexões do MongoDB | 10 | Não |
Banco de auditoria (PostgreSQL)
| Variável | Descrição | Padrão | Obrigatória |
|---|
AUDIT_DB_HOST | Host do banco de auditoria | — | Sim (fatal se ausente) |
AUDIT_DB_PORT | Porta do banco de auditoria | 5432 | Não |
AUDIT_DB_USER | Usuário do banco de auditoria. Padrão: flowker_audit se não definido. | flowker_audit | Não |
AUDIT_DB_PASSWORD | Senha do banco de auditoria. Padrão: flowker_audit se não definido. | flowker_audit | Não |
AUDIT_DB_NAME | Nome do banco de auditoria | flowker_audit | Não |
AUDIT_DB_SSL_MODE | Modo SSL para conexão com o banco de auditoria | disable | Não |
AUDIT_MIGRATIONS_PATH | Caminho para os arquivos de migração do banco de auditoria | /migrations | Não |
Observabilidade
| Variável | Descrição | Padrão | Obrigatória |
|---|
ENABLE_TELEMETRY | Habilitar instrumentação OpenTelemetry | false | Não |
OTEL_EXPORTER_OTLP_ENDPOINT | Endpoint do exportador OTLP | — | Sim (se ENABLE_TELEMETRY=true) |
OTEL_RESOURCE_SERVICE_NAME | Nome do serviço para telemetria | flowker | Não |
OTEL_RESOURCE_SERVICE_VERSION | Versão do serviço para telemetria | — | Não |
OTEL_RESOURCE_DEPLOYMENT_ENVIRONMENT | Label de ambiente de deploy | — | Não |
OTEL_LIBRARY_NAME | Nome da biblioteca de instrumentação | — | Não |
SKIP_LIB_COMMONS_TELEMETRY | Ignorar telemetria da biblioteca commons | false | Não |
LOG_LEVEL | Nível de log (debug/info/warn/error) | debug | Não |
Segurança
| Variável | Descrição | Padrão | Obrigatória |
|---|
SSRF_ALLOW_PRIVATE | Permitir chamadas HTTP de executors para IPs privados | false | Não |
FAULT_INJECTION_ENABLED | Habilitar injeção de falhas para testes | false | Não |
Swagger
| Variável | Descrição | Padrão | Obrigatória |
|---|
SWAGGER_TITLE | Título da UI do Swagger | varia | Não |
SWAGGER_DESCRIPTION | Descrição da UI do Swagger | varia | Não |
SWAGGER_VERSION | Versão da API no Swagger | varia | Não |
SWAGGER_HOST | Host do Swagger | varia | Não |
SWAGGER_BASE_PATH | Base path do Swagger | varia | Não |
SWAGGER_SCHEMES | Esquemas de URL do Swagger | varia | Não |