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.

This reference lists all environment variables used by Flowker. Variables marked as required will cause the server to fail on startup if not set.

Server

VariableDescriptionDefaultRequired
ENV_NAMEEnvironment name (dev/staging/production)developmentNo
SERVER_ADDRESSServer bind address:4021No
CORS_ALLOWED_ORIGINSAllowed CORS origins*No

Authentication

VariableDescriptionDefaultRequired
API_KEYAPI key for X-API-Key header authYes (if API_KEY_ENABLED=true)
API_KEY_ENABLEDEnable API key authenticationfalseNo
PLUGIN_AUTH_ENABLEDEnable Access Manager plugin authentication as alternative to API KeyfalseNo
PLUGIN_AUTH_ADDRESSgRPC address of Access Manager serviceYes (if PLUGIN_AUTH_ENABLED=true)

Database (MongoDB)

VariableDescriptionDefaultRequired
MONGO_URIMongoDB connection URIYes
MONGO_DB_NAMEMongoDB database nameflowkerNo
MONGO_TLS_CA_CERTBase64-encoded PEM CA certificate for TLS connections (e.g., AWS DocumentDB)No
MONGO_MAX_POOL_SIZEMaximum MongoDB connection pool size10No

Audit database (PostgreSQL)

VariableDescriptionDefaultRequired
AUDIT_DB_HOSTAudit database hostYes (fatal if missing)
AUDIT_DB_PORTAudit database port5432No
AUDIT_DB_USERAudit database user. Defaults to flowker_audit if not set.flowker_auditNo
AUDIT_DB_PASSWORDAudit database password. Defaults to flowker_audit if not set.flowker_auditNo
AUDIT_DB_NAMEAudit database nameflowker_auditNo
AUDIT_DB_SSL_MODESSL mode for audit DB connectiondisableNo
AUDIT_MIGRATIONS_PATHPath to audit database migration files/migrationsNo

Observability

VariableDescriptionDefaultRequired
ENABLE_TELEMETRYEnable OpenTelemetry instrumentationfalseNo
OTEL_EXPORTER_OTLP_ENDPOINTOTLP exporter endpointYes (if ENABLE_TELEMETRY=true)
OTEL_RESOURCE_SERVICE_NAMEService name for telemetryflowkerNo
OTEL_RESOURCE_SERVICE_VERSIONService version for telemetryNo
OTEL_RESOURCE_DEPLOYMENT_ENVIRONMENTDeployment environment labelNo
OTEL_LIBRARY_NAMEInstrumentation library nameNo
SKIP_LIB_COMMONS_TELEMETRYSkip commons library telemetryfalseNo
LOG_LEVELLog level (debug/info/warn/error)debugNo

Security

VariableDescriptionDefaultRequired
SSRF_ALLOW_PRIVATEAllow executor HTTP calls to private IPsfalseNo
FAULT_INJECTION_ENABLEDEnable fault injection for testingfalseNo

Swagger

VariableDescriptionDefaultRequired
SWAGGER_TITLESwagger UI titlevariesNo
SWAGGER_DESCRIPTIONSwagger UI descriptionvariesNo
SWAGGER_VERSIONSwagger API versionvariesNo
SWAGGER_HOSTSwagger hostvariesNo
SWAGGER_BASE_PATHSwagger base pathvariesNo
SWAGGER_SCHEMESSwagger URL schemesvariesNo