Variables de entorno

Referencia de las variables de entorno de Flowker: servidor, autenticación, MongoDB, scheduler, URLs de los proveedores nativos, registro de schemas, ingreso de Streaming Hub, caché de tokens, observabilidad y límites.

Esta referencia enumera las variables de entorno que configuran Flowker.

La columna Valor predeterminado muestra el valor que Flowker aplica cuando no configuras una variable. Un guion significa que Flowker no aplica ningún valor propio. La columna Obligatoria marca las variables sin las cuales el servidor no inicia. Una variable marcada como Sensible lleva una credencial.

Flowker tiene dos binarios. El binario de la API sirve la API HTTP. El binario del worker ejecuta el scheduler que dispara los workflows con disparador schedule y retoma las ejecuciones detenidas en un nodo de espera. Una variable que se aplica a un solo binario lo indica.

Una variable booleana acepta solo true o false. Cualquier otro valor impide que los dos binarios inicien. Un entero o una duración malformados también los impiden.

​

Servidor

Variable	Descripción	Valor predeterminado	Obligatoria
ENV_NAME	Entorno del despliegue: production, staging, uat, development o local. Cualquier otro valor impide que el servidor inicie. Con production, PLUGIN_AUTH_ENABLED, XSD_SCHEMAS_AUTH_ENABLED y OPENAPI_SCHEMAS_AUTH_ENABLED deben ser true, o el servidor no inicia.	—	Sí
SERVER_ADDRESS	Dirección de escucha del binario de la API, por ejemplo :4021.	—	No
WORKER_SERVER_ADDRESS	Dirección de escucha del binario del worker.	:4022	No
CORS_ALLOWED_ORIGINS	Orígenes, separados por comas, permitidos en solicitudes cross-origin.	—	No
TRUSTED_PROXIES	Rangos CIDR, separados por comas, de tus balanceadores de carga o de tu ingress. Flowker lee la IP del cliente en X-Forwarded-For solo cuando la solicitud pasa por uno de estos rangos. Access Manager verifica su lista de IP permitidas contra esa IP del cliente. Una entrada que no es un rango CIDR impide que el servidor inicie.	—	No
SHUTDOWN_DRAIN_DELAY	Tiempo que los listeners siguen atendiendo después de la señal de parada, como una duración Go, por ejemplo 15s. Un valor malformado impide que el binario inicie.	15s dentro de un pod de Kubernetes, 0 en los demás casos	No
SHUTDOWN_TIMEOUT	Mayor tiempo que el binario espera a que termine el trabajo en curso cuando se detiene, como una duración Go positiva. Un valor malformado impide que el binario inicie.	30s	No
PPROF_ENABLED	Sirve datos de profiling de Go en /debug/pprof/ en 127.0.0.1:6060, solo en el binario del worker.	false	No

​

Licencia

Variable	Descripción	Valor predeterminado	Obligatoria
LICENSE_KEY	Clave de licencia del producto. Sensible. La licencia es global. Ninguno de los binarios inicia sin una clave válida. Cuando Flowker rechaza la licencia mientras corre, deja de aceptar trabajo, drena lo que está en curso y termina. /readyz informa la licencia.	—	Sí

​

Despliegue

Variable	Descripción	Valor predeterminado	Obligatoria
DEPLOYMENT_MODE	Modo de despliegue. Con saas, MONGO_URI debe usar mongodb+srv:// o llevar tls=true o ssl=true, o el servidor no inicia. Cuando no está configurada, /readyz informa local.	—	No

​

Autenticación

Variable	Descripción	Valor predeterminado	Obligatoria
PLUGIN_AUTH_ENABLED	Exige la autenticación de Access Manager en las rutas de workflow, de webhook y de gestión. Con false, estas rutas no exigen un token.	false	No
PLUGIN_AUTH_ADDRESS	Dirección de Access Manager. Flowker también obtiene de ella el endpoint de token de los proveedores nativos, con /v1/login/oauth/access_token agregado al final.	—	Cuando PLUGIN_AUTH_ENABLED=true
AUTH_M2M_INVERSION_ENABLED	Con true, un token de aplicación autoriza con su propia identidad, y un token cuyo type no es normal-user ni application responde 401. Cualquier otro valor cuenta como false.	false	No
AUTH_M2M_PRODUCT_FORWARD_ENABLED	Con true y AUTH_M2M_INVERSION_ENABLED=true, Flowker envía el nombre del producto con la solicitud de autorización de un token de aplicación. Cualquier otro valor cuenta como false.	false	No
XSD_SCHEMAS_AUTH_ENABLED	Con true, las rutas /v1/xsd-schemas siguen a PLUGIN_AUTH_ENABLED. Con false, no requieren token. Un valor sin definir o en blanco cuenta como true.	true	No
OPENAPI_SCHEMAS_AUTH_ENABLED	Con true, las rutas /v1/openapi-schemas siguen a PLUGIN_AUTH_ENABLED. Con false, no requieren token. Un valor sin definir o en blanco cuenta como true.	true	No

​

MongoDB

Variable	Descripción	Valor predeterminado	Obligatoria
MONGO_URI	URI de conexión de MongoDB. Sensible.	—	Sí
MONGO_DB_NAME	Nombre de la base de datos de MongoDB.	—	Sí
MONGO_MAX_POOL_SIZE	Tamaño máximo del pool de conexiones de MongoDB. Un valor no configurado, o un valor igual o menor que cero, mantiene el valor predeterminado del driver de MongoDB.	—	No
MONGO_TLS_CA_CERT	Certificado de CA en PEM, codificado en Base64, para la conexión TLS con MongoDB.	—	No

​

Scheduler y Redis

El binario del worker ejecuta el scheduler. Los dos binarios se conectan a Redis mediante las variables REDIS_*. El worker usa Redis para la cola del scheduler, y el binario de la API lo usa para encolar la ejecución de una ocurrencia estacionada.

Variable	Descripción	Valor predeterminado	Obligatoria
SCHEDULER_ENABLED	Activa o desactiva el scheduler. Un valor sin definir o en blanco cuenta como true. El binario del worker no inicia cuando el valor es false, así que ni las ejecuciones programadas ni las ejecuciones detenidas en un nodo de espera continúan.	true	No
REDIS_HOST	Host de Redis. Cuando el scheduler está activo y el host está vacío, el binario del worker no inicia. El binario de la API entonces responde a las rutas de programación con FLK-0763.	—	Cuando SCHEDULER_ENABLED=true
REDIS_PORT	Puerto de Redis.	6379	No
REDIS_PASSWORD	Contraseña de Redis. Sensible.	—	Binario del worker, cuando SCHEDULER_ENABLED=true y DEPLOYMENT_MODE=saas
REDIS_TLS	Usa TLS en la conexión con Redis.	false	No
REDIS_DB	Índice lógico de la base de datos de Redis.	0	No
SCHEDULER_CONCURRENCY	Número máximo de ejecuciones programadas que el worker procesa al mismo tiempo. Un valor igual o menor que cero cuenta como 10.	10	No

​

URLs de los proveedores nativos

Flowker lee la URL base de cada proveedor nativo de estas variables, y no de la configuración de proveedor guardada. Para los proveedores tracer y auth, una variable vacía hace que Flowker use el valor de la configuración guardada. Para los proveedores ledger, crm, fees, identity y pix-jd, el host siempre viene de la variable o de la especificación publicada del proveedor, y la configuración guardada no acepta base_url.

Variable	Descripción	Valor predeterminado	Obligatoria
MIDAZ_BASE_URL	URL base del proveedor ledger. Es la URL base de transacciones y la URL base de onboarding.	—	No
TRACER_BASE_URL	URL base del proveedor tracer.	—	No
CRM_BASE_URL	URL base del proveedor crm.	—	No
FEES_BASE_URL	URL base del proveedor fees.	—	No
IDENTITY_BASE_URL	URL base del proveedor identity.	—	No
AUTH_BASE_URL	URL base del proveedor auth.	—	No
PIX_JD_BASE_URL	URL base del proveedor pix-jd.	—	No
OPENAPI_NATIVE_PROVIDERS	IDs, separados por comas, de los proveedores nativos que Flowker construye a partir de su especificación OpenAPI publicada. Vacío deja disponibles todos los proveedores nativos. Flowker ignora un ID desconocido.	—	No

​

Registro de schemas y validación XSD

Variable	Descripción	Valor predeterminado	Obligatoria
SCHEMA_REGISTRY_S3_BUCKET	Bucket S3 que almacena el contenido de los schemas XSD y OpenAPI. Flowker inicia sin él, pero las operaciones que leen o escriben contenido de schema fallan.	—	No
SCHEMA_REGISTRY_S3_REGION	Región de AWS del bucket. Cuando está vacía, la región viene de la configuración estándar de AWS.	—	No
XSD_VALIDATOR_URL	URL base del validador XSD. Vacío desactiva la validación de schema XML. La URL debe usar https, o http con XSD_VALIDATOR_ALLOW_INSECURE_HTTP=true. Cualquier otra URL impide que el servidor inicie.	—	No
XSD_VALIDATOR_ALLOW_INSECURE_HTTP	Acepta un valor http:// en XSD_VALIDATOR_URL. Define true para activarlo.	false	No

​

Ingreso de Streaming Hub

Variable	Descripción	Valor predeterminado	Obligatoria
HUB_WEBHOOK_ENABLED	Sirve la ruta firmada de Streaming Hub en /v1/hub/webhooks/. Con true, el servidor no inicia sin el almacén de credenciales que guarda cada secreto de firma.	false	No
HUB_WEBHOOK_SIGNING_SECRETS	Signing secrets de entrada, separados por comas, contra los que Flowker comprueba una entrega de Streaming Hub. Aplica solo sin multi-tenancy: con multi-tenancy, el secret de cada tenant viene del almacén de credenciales. Sensible.	—	Cuando HUB_WEBHOOK_ENABLED=true sin multi-tenancy
HUB_WEBHOOK_TOLERANCE_SEC	Ventana de validez de la firma de una entrega, en segundos. Un valor igual o menor que cero cuenta como el valor predeterminado.	300	No

​

Caché de tokens de proveedor

Variable	Descripción	Valor predeterminado	Obligatoria
TOKEN_CACHE_MAX_TTL_SEC	Tiempo máximo durante el cual Flowker confía en un token de proveedor en caché, en segundos, sea cual sea el expires_in que devuelve el proveedor.	3600	No
TOKEN_CACHE_JANITOR_INTERVAL_SEC	Intervalo en que Flowker elimina de la caché los tokens vencidos, en segundos.	300	No
TOKEN_CACHE_REFRESH_BUFFER_SEC	Tiempo antes del vencimiento en que Flowker obtiene un nuevo token, en segundos. Cuando no está configurada, se aplica la ventana de renovación de cada proveedor.	—	No

​

Observabilidad

Variable	Descripción	Valor predeterminado	Obligatoria
ENABLE_TELEMETRY	Activa la exportación de OpenTelemetry.	false	No
OTEL_EXPORTER_OTLP_ENDPOINT	Endpoint del exportador OTLP.	—	Cuando ENABLE_TELEMETRY=true
OTEL_RESOURCE_SERVICE_NAME	Nombre del servicio en la telemetría y en el campo service de /version.	flowker	No
OTEL_RESOURCE_DEPLOYMENT_ENVIRONMENT	Etiqueta del entorno de despliegue en la telemetría.	—	No
OTEL_LIBRARY_NAME	Nombre de la biblioteca de instrumentación. El logger la exige, también cuando ENABLE_TELEMETRY es false.	—	Sí
LOG_LEVEL	Nivel de log: debug, info, warn, error, dpanic, panic o fatal. Cuando no está configurada, development y local registran en debug, y todos los demás entornos registran en info. Un nivel no reconocido impide que el servidor inicie.	—	No
SKIP_LIB_COMMONS_TELEMETRY	Quita el middleware de telemetría de las rutas HTTP.	false	No

​

Límites y configuraciones de prueba

Variable	Descripción	Valor predeterminado	Obligatoria
HTTP_MAX_BODY_BYTES	Mayor cuerpo de solicitud que Flowker envía a un proveedor, y mayor cuerpo de respuesta que lee de un proveedor, en bytes. Un valor igual o menor que cero cuenta como el valor predeterminado.	10485760 (10 MiB)	No
SSRF_ALLOW_PRIVATE	Permite que las llamadas HTTP a proveedores alcancen direcciones IP privadas. Solo el valor exacto true la activa.	false	No
FAULT_INJECTION_ENABLED	Responde con una falla simulada a una solicitud que lleva el encabezado X-Test-Fault-Injection.	false	No

​

Documentación OpenAPI

Variable	Descripción	Valor predeterminado	Obligatoria
SWAGGER_ENABLED	Sirve la especificación OpenAPI y la interfaz de documentación en /openapi/openapi.json, /openapi/openapi.yaml y /openapi/docs.	false	No
SWAGGER_TITLE	Título de la página de la interfaz de documentación.	—	No