Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.servflow.io/llms.txt

Use this file to discover all available pages before exploring further.

ServFlow Pro is configured using a TOML file. This reference covers all available configuration options for running ServFlow in development and production environments.
All configuration values can be overridden using environment variables, making it easy to manage settings across different environments.

​
Server Configuration

The [server] section configures the main API server that handles incoming requests to your workflows. 
[server]
port = "8080"
config_folder = "./configs"
engine_config_file = "./integrations.yaml"
env = "production"
FieldEnvironment VariableDefaultDescription
portSERVFLOW_SERVER_PORT8080Port for the API server
config_folderSERVFLOW_SERVER_CONFIG_FOLDER—Required. Directory containing API configuration files
engine_config_fileSERVFLOW_SERVER_ENGINE_CONFIG_FILE—Path to engine integrations YAML file
envSERVFLOW_SERVER_ENVproductionEnvironment mode (production or development)
The config_folder is the only required configuration. ServFlow will use sensible defaults for all other settings.

​
Dashboard Configuration

The [dashboard] section configures the web dashboard interface for building and managing APIs visually. 
[dashboard]
port = "3000"
configs_folder = "./configs"
master_key = "your-secure-master-key"
FieldEnvironment VariableDefaultDescription
portSERVFLOW_DASHBOARD_PORT3000Port for the dashboard server
configs_folderSERVFLOW_DASHBOARD_CONFIGS_FOLDERSame as server.config_folderDirectory for dashboard config storage
master_keySERVFLOW_DASHBOARD_MASTER_KEY—Master encryption key for secrets (required for secrets management)
Keep your master_key secure and never commit it to version control. Use environment variables in production.

​
SQLite Configuration

The [sqlite] section configures persistent storage for secrets, OAuth tokens, and metrics. 
[sqlite]
path = "./data/servflow.db"
FieldEnvironment VariableDefaultDescription
pathSERVFLOW_SQLITE_PATH./database.dbPath to SQLite database file
If the path is empty or the [sqlite] section is omitted, ServFlow falls back to file-based storage with reduced functionality. See Secrets Management for details on what features require SQLite.

​
Tracing Configuration

The [tracing] section configures OpenTelemetry distributed tracing for debugging and monitoring your API workflows. 
[tracing]
enabled = false
service_name = "servflow-pro"
org_id = ""
collector_endpoint = ""
FieldEnvironment VariableDefaultDescription
enabledSERVFLOW_TRACING_ENABLEDfalseEnable OpenTelemetry tracing
service_nameSERVFLOW_TRACING_SERVICE_NAME—Service name for trace identification
org_idSERVFLOW_TRACING_ORG_ID—Organization ID for multi-tenant collectors
collector_endpointSERVFLOW_TRACING_COLLECTOR_ENDPOINT—OTLP collector endpoint URL
For local development, you can use Jaeger as a tracing collector. See the Local Environment Setup guide for instructions.

​
Complete Example

Here’s a complete configuration file with all available options: 
[server]
port = "8080"
config_folder = "./configs"
engine_config_file = "./integrations.yaml"
env = "production"

[dashboard]
port = "3000"
configs_folder = "./configs"
master_key = "your-secure-master-key"

[sqlite]
path = "./data/servflow.db"

[tracing]
enabled = false
service_name = "servflow-pro"
org_id = ""
collector_endpoint = ""

​
Environment Variable Overrides

Environment variables take precedence over values in the TOML file. This is useful for:
  • Production deployments — Keep secrets out of configuration files
  • Container environments — Configure via Docker/Kubernetes environment variables
  • CI/CD pipelines — Override settings per environment
Example using environment variables with Docker: 
docker run -d \
  --name servflow-pro \
  -e SERVFLOW_SERVER_PORT=9000 \
  -e SERVFLOW_DASHBOARD_MASTER_KEY=my-secret-key \
  -e SERVFLOW_SQLITE_PATH=/data/servflow.db \
  -v $(pwd)/config.toml:/app/config.toml \
  servflow/servflow-pro start --config /app/config.toml --dashboard

​
Next Steps

Local Environment Setup

Set up ServFlow Pro for local development with detailed configuration examples.

Secrets Management

Learn how to securely manage API keys and credentials.

Installation

Deploy ServFlow Pro to your infrastructure.

Quickstart

Build your first API with ServFlow.