This repository contains configuration files and workflows for various application features. It is organized into directories based on functionality, making it easy to locate and manage specific configurations.
If you are new to FlowSynx and haven't done so already, it is recommended you go through the FlowSynx Getting Started instructions.
Each subfolder represents a distinct configuration area, making it easy to enable, disable, or customize individual features without affecting the rest of the system. The configuration/ directory contains configuration files for different FlowSynx features. Each subdirectory represents a distinct configuration area, making it easy to enable, disable, or customize individual features without affecting the rest of the system:
| Directory | Purpose |
|---|---|
| HealthCheck | Defines application health-check probes, such as liveness and readiness endpoints. Useful for Kubernetes, Docker, and container orchestration platforms. |
| Endpoints | Configures HTTP endpoint ports, server URLs, and optional HTTPS/TLS settings. Supports binding to multiple interfaces. |
| Cors | Manages Cross-Origin Resource Sharing (CORS) policies. Controls which external domains can access FlowSynx APIs. |
| Localization | Provides language and locale settings. Currently supports English (en) by default, with placeholders for future multilingual expansion. |
| RateLimiting | Enables API request throttling to protect against abuse or accidental traffic spikes. Supports per-user, per-endpoint, and global limits. |
| WorkflowQueue | Specifies the workflow queue provider (e.g., InMemory, Durable). Controls retry policies and message durability. |
| Basic_Auth | Defines static user accounts, roles, and credentials for basic authentication. Useful for local development or simple deployments. |
| Keycloak_Auth | Integrates with Keycloak or other OpenID Connect providers for secure authentication and role-based access control. Recommended for production. |
The workflows/ directory contains predefined JSON workflow configurations designed for a variety of use cases, such as data processing, automation pipelines, and system integrations. Each workflow file defines a sequence of tasks, dependencies, and execution logic that can be customized or extended as needed.
| Directory | Description |
|---|---|
| Basic | Includes minimal JSON-based workflow definition, such as a simple example that writes text to a file. |
| NightlyDatabaseBackup | Includes JSON-based workflow definition for Dump PostgreSQL database, compress, and store it to Azure Blob Storage. |
| WeatherDataETL | Fetch hourly weather JSON, normalize, insert into PostgreSQL. |
| ImageProcessingPipeline | Load a local image, convert it to grayscale, apply a watermark, and then upload it to Google Cloud Storage. |