Skip to main content

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ávelDescriçãoPadrãoObrigatória
ENV_NAMENome do ambiente (dev/staging/production)developmentNão
SERVER_ADDRESSEndereço de bind do servidor:4021Não
CORS_ALLOWED_ORIGINSOrigens CORS permitidas*Não

Autenticação

VariávelDescriçãoPadrãoObrigatória
API_KEYChave de API para autenticação via header X-API-KeySim (se API_KEY_ENABLED=true)
API_KEY_ENABLEDHabilitar autenticação por chave de APIfalseNão
PLUGIN_AUTH_ENABLEDHabilitar autenticação via plugin do Access Manager como alternativa à API KeyfalseNão
PLUGIN_AUTH_ADDRESSEndereço gRPC do serviço Access ManagerSim (se PLUGIN_AUTH_ENABLED=true)

Banco de dados (MongoDB)

VariávelDescriçãoPadrãoObrigatória
MONGO_URIURI de conexão do MongoDBSim
MONGO_DB_NAMENome do banco de dados MongoDBflowkerNão
MONGO_TLS_CA_CERTCertificado CA em PEM codificado em Base64 para conexões TLS (ex: AWS DocumentDB)Não
MONGO_MAX_POOL_SIZETamanho máximo do pool de conexões do MongoDB10Não

Banco de auditoria (PostgreSQL)

VariávelDescriçãoPadrãoObrigatória
AUDIT_DB_HOSTHost do banco de auditoriaSim (fatal se ausente)
AUDIT_DB_PORTPorta do banco de auditoria5432Não
AUDIT_DB_USERUsuário do banco de auditoria. Padrão: flowker_audit se não definido.flowker_auditNão
AUDIT_DB_PASSWORDSenha do banco de auditoria. Padrão: flowker_audit se não definido.flowker_auditNão
AUDIT_DB_NAMENome do banco de auditoriaflowker_auditNão
AUDIT_DB_SSL_MODEModo SSL para conexão com o banco de auditoriadisableNão
AUDIT_MIGRATIONS_PATHCaminho para os arquivos de migração do banco de auditoria/migrationsNão

Observabilidade

VariávelDescriçãoPadrãoObrigatória
ENABLE_TELEMETRYHabilitar instrumentação OpenTelemetryfalseNão
OTEL_EXPORTER_OTLP_ENDPOINTEndpoint do exportador OTLPSim (se ENABLE_TELEMETRY=true)
OTEL_RESOURCE_SERVICE_NAMENome do serviço para telemetriaflowkerNão
OTEL_RESOURCE_SERVICE_VERSIONVersão do serviço para telemetriaNão
OTEL_RESOURCE_DEPLOYMENT_ENVIRONMENTLabel de ambiente de deployNão
OTEL_LIBRARY_NAMENome da biblioteca de instrumentaçãoNão
SKIP_LIB_COMMONS_TELEMETRYIgnorar telemetria da biblioteca commonsfalseNão
LOG_LEVELNível de log (debug/info/warn/error)debugNão

Segurança

VariávelDescriçãoPadrãoObrigatória
SSRF_ALLOW_PRIVATEPermitir chamadas HTTP de executors para IPs privadosfalseNão
FAULT_INJECTION_ENABLEDHabilitar injeção de falhas para testesfalseNão

Swagger

VariávelDescriçãoPadrãoObrigatória
SWAGGER_TITLETítulo da UI do SwaggervariaNão
SWAGGER_DESCRIPTIONDescrição da UI do SwaggervariaNão
SWAGGER_VERSIONVersão da API no SwaggervariaNão
SWAGGER_HOSTHost do SwaggervariaNão
SWAGGER_BASE_PATHBase path do SwaggervariaNão
SWAGGER_SCHEMESEsquemas de URL do SwaggervariaNão