ByteChef LogoByteChef
Deployment

Environment Variables

Configuration options for ByteChef through environment variables

ByteChef can be configured using environment variables. This page documents all available environment variables, organized by category.

AI Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_AI_COPILOT_ENABLEDEnable or disable the AI copilot featurefalse
BYTECHEF_AI_COPILOT_PROVIDERThe AI provider to use for copilot (OPENAI, ANTHROPIC)OPENAI
BYTECHEF_AI_COPILOT_OPENAI_API_KEYOpenAI API key for copilot (sensitive)-
BYTECHEF_AI_COPILOT_OPENAI_CHAT_OPTIONS_MODELOpenAI model to use for chatchatgpt-4o-latest
BYTECHEF_AI_COPILOT_OPENAI_CHAT_OPTIONS_TEMPERATURETemperature setting for OpenAI chat0.4

AI Providers

Environment VariableDescriptionDefault Value
BYTECHEF_AI_PROVIDER_ANTHROPIC_API_KEYAnthropic API key (sensitive)-
BYTECHEF_AI_PROVIDER_AZURE_OPENAI_API_KEYAzure OpenAI API key (sensitive)-
BYTECHEF_AI_PROVIDER_DEEP_SEEK_API_KEYDeepSeek API key (sensitive)-
BYTECHEF_AI_PROVIDER_GROQ_API_KEYGroq API key (sensitive)-
BYTECHEF_AI_PROVIDER_NVIDIA_API_KEYNVIDIA API key (sensitive)-
BYTECHEF_AI_PROVIDER_HUGGING_FACE_API_KEYHuggingFace API key (sensitive)-
BYTECHEF_AI_PROVIDER_MISTRAL_API_KEYMistral API key (sensitive)-
BYTECHEF_AI_PROVIDER_OPENAI_API_KEYOpenAI API key (sensitive)-
BYTECHEF_AI_PROVIDER_PERPLEXITY_API_KEYPerplexity API key (sensitive)-
BYTECHEF_AI_PROVIDER_STABILITY_API_KEYStability API key (sensitive)-
BYTECHEF_AI_PROVIDER_VERTEX_GEMINI_API_KEYVertex Gemini API key (sensitive)-

Analytics Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_ANALYTICS_ENABLEDEnable or disable analyticstrue

Cache Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_CACHE_PROVIDERCache provider (REDIS, CAFFEINE)CAFFEINE

Cloud Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_CLOUD_PROVIDERCloud provider (AWS, NONE)NONE
BYTECHEF_CLOUD_AWS_ACCESS_KEY_IDAWS access key ID (sensitive)-
BYTECHEF_CLOUD_AWS_SECRET_ACCESS_KEYAWS secret access key (sensitive)-
BYTECHEF_CLOUD_AWS_REGIONAWS region-
BYTECHEF_CLOUD_AWS_ACCOUNT_IDAWS account ID-

Component Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_COMPONENT_REGISTRY_EXCLUDEList of components to exclude from registry-

Coordinator Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_COORDINATOR_ENABLEDEnable or disable the coordinatortrue

Coordinator Task Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_APPLICATION_EVENTSNumber of application event subscribers1
BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_RESUME_JOB_EVENTSNumber of resume job event subscribers1
BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_START_JOB_EVENTSNumber of start job event subscribers1
BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_STOP_JOB_EVENTSNumber of stop job event subscribers1
BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_TASK_EXECUTION_COMPLETE_EVENTSNumber of task execution complete event subscribers1
BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_TASK_EXECUTION_ERROR_EVENTSNumber of task execution error event subscribers1

Coordinator Trigger Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_COORDINATOR_TRIGGER_SCHEDULER_PROVIDERScheduler provider (AWS, QUARTZ)QUARTZ
BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_APPLICATION_EVENTSNumber of application event subscribers1
BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_TRIGGER_EXECUTION_COMPLETE_EVENTSNumber of trigger execution complete event subscribers1
BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_TRIGGER_EXECUTION_ERROR_EVENTSNumber of trigger execution error event subscribers1
BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_TRIGGER_LISTENER_EVENTSNumber of trigger listener event subscribers1
BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_TRIGGER_POLL_EVENTSNumber of trigger poll event subscribers1
BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_TRIGGER_WEBHOOK_EVENTSNumber of trigger webhook event subscribers1

Datasource Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_DATASOURCE_URLDatabase URL-
BYTECHEF_DATASOURCE_USERNAMEDatabase username (sensitive)-
BYTECHEF_DATASOURCE_PASSWORDDatabase password (sensitive)-

Data Storage Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_DATA_STORAGE_PROVIDERData storage provider (AWS, FILESYSTEM, JDBC)JDBC

Discovery Service Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_DISCOVERY_SERVICE_PROVIDERDiscovery service provider (REDIS)REDIS

Edition Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_EDITIONByteChef edition (CE, EE)EE

Encryption Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_ENCRYPTION_PROVIDEREncryption provider (FILESYSTEM, PROPERTY)FILESYSTEM
BYTECHEF_ENCRYPTION_PROPERTY_KEYEncryption key (sensitive)-

Feature Flags

Environment VariableDescriptionDefault Value
BYTECHEF_FEATURE_FLAGSList of enabled feature flags-

File Storage Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_FILE_STORAGE_PROVIDERFile storage provider (AWS, FILESYSTEM, JDBC)FILESYSTEM
BYTECHEF_FILE_STORAGE_FILESYSTEM_BASEDIRBase directory for filesystem storage-
BYTECHEF_FILE_STORAGE_AWS_BUCKETAWS S3 bucket name-

Help Hub Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_HELP_HUB_ENABLEDEnable or disable the help hubtrue

Observability Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_OBSERVABILITY_LOKI_APPENDER_LEVELLog level for Loki appenderALL
BYTECHEF_OBSERVABILITY_LOKI_APPENDER_HTTP_URLLoki HTTP URLhttp://localhost:3100/loki/api/v1/push

Mail Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_MAIL_AUTHEnable mail authenticationfalse
BYTECHEF_MAIL_BASE_URLBase URL for mail linksBYTECHEF_PUBLIC_URL
BYTECHEF_MAIL_DEBUGEnable mail debugfalse
BYTECHEF_MAIL_FROMFrom email addressnoreply@app.bytechef.io
BYTECHEF_MAIL_HOSTMail server hostlocalhost
BYTECHEF_MAIL_PASSWORDMail password (sensitive)-
BYTECHEF_MAIL_PORTMail server port25
BYTECHEF_MAIL_PROTOCOLMail protocolsmtp
BYTECHEF_MAIL_SSL_ENABLEDEnable SSL for mailfalse
BYTECHEF_MAIL_STARTTLS_ENABLEEnable STARTTLSfalse
BYTECHEF_MAIL_STARTTLS_REQUIREDRequire STARTTLSfalse
BYTECHEF_MAIL_USERNAMEMail username (sensitive)-

Message Broker Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_MESSAGE_BROKER_PROVIDERMessage broker provider (AMQP, AWS, JMS, KAFKA, LOCAL, REDIS)JMS

OAuth2 Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_OAUTH2_REDIRECT_URIOAuth2 redirect URIBYTECHEF_PUBLIC_URL/callback
BYTECHEF_OAUTH2_PREDEFINED_APPS_<APP_NAME>_CLIENT_IDClient ID for predefined OAuth2 app (sensitive)-
BYTECHEF_OAUTH2_PREDEFINED_APPS_<APP_NAME>_CLIENT_SECRETClient secret for predefined OAuth2 app (sensitive)-

Public URL Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_PUBLIC_URLPublic URL of the ByteChef instancehttp://127.0.0.1:8080

Resources Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_RESOURCES_WEBWeb resources locationfile:///opt/bytechef/client/

Security Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_SECURITY_CONTENT_SECURITY_POLICYContent Security Policy"default-src 'self'; frame-src 'self' https://.command.ai data:; script-src 'self' 'unsafe-inline' 'unsafe-eval' https://.command.ai https://.commandbar.com https://.i.posthog.com https://cdn.jsdelivr.net https://storage.googleapis.com https://unpkg.com; style-src 'self' 'unsafe-inline' https://.commandbar.com https://cdn.jsdelivr.net https://.command.ai https://unpkg.com; img-src 'self' https://.command.ai data:; font-src 'self' data:; media-src 'self' https://.command.ai; connect-src 'self' https://.command.ai https://.i.posthog.com https://*.commandbar.com; worker-src blob: 'self';"
BYTECHEF_SECURITY_REMEMBER_ME_KEYRemember Me key (sensitive)-
BYTECHEF_SECURITY_SYSTEM_USERNAMESystem administrator usernamesystem_admin
BYTECHEF_SECURITY_SYSTEM_PASSWORDSystem administrator password (sensitive)-

System administrator is used for accessing protected data reachable through /actuator/** endpoints. For example /actuator/env returns all environment properties.

Sign Up Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_SIGNUP_ACTIVATION_REQUIREDRequire account activationfalse
BYTECHEF_SIGNUP_ENABLEDEnable sign uptrue

Tenant Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_TENANT_MODETenant mode (MULTI, SINGLE)SINGLE

Webhook URL Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_WEBHOOK_URLWebhook URLBYTECHEF_PUBLIC_URL/webhooks/{id}

Tracing Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_TRACING_OTLP_ENDPOINTOpenTelemetry endpointhttp://localhost:4318/v1/traces

Worker Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_WORKER_ENABLEDEnable or disable the workertrue
BYTECHEF_WORKER_TASK_SUBSCRIPTIONS_DEFAULTNumber of subscribers for default worker queue10
BYTECHEF_WORKER_TASK_SUBSCRIPTIONS_<EVENT_TYPE>Number of subscribers for specific worker queue-

Workflow Configuration

Output Storage

Environment VariableDescriptionDefault Value
BYTECHEF_WORKFLOW_OUTPUT_STORAGE_PROVIDEROutput storage provider (AWS, FILESYSTEM, JDBC)JDBC

Repository Configuration

Environment VariableDescriptionDefault Value
BYTECHEF_WORKFLOW_REPOSITORY_CLASSPATH_ENABLEDEnable classpath repositoryfalse
BYTECHEF_WORKFLOW_REPOSITORY_CLASSPATH_LOCATION_PATTERNClasspath location pattern-
BYTECHEF_WORKFLOW_REPOSITORY_FILESYSTEM_ENABLEDEnable filesystem repositoryfalse
BYTECHEF_WORKFLOW_REPOSITORY_FILESYSTEM_LOCATION_PATTERNFilesystem location pattern-
BYTECHEF_WORKFLOW_REPOSITORY_GIT_ENABLEDEnable Git repositoryfalse
BYTECHEF_WORKFLOW_REPOSITORY_GIT_URLGit repository URL-
BYTECHEF_WORKFLOW_REPOSITORY_GIT_BRANCHGit repository branch-
BYTECHEF_WORKFLOW_REPOSITORY_GIT_USERNAMEGit username (sensitive)-
BYTECHEF_WORKFLOW_REPOSITORY_GIT_PASSWORDGit password (sensitive)-
BYTECHEF_WORKFLOW_REPOSITORY_GIT_SEARCH_PATHSGit search paths-
BYTECHEF_WORKFLOW_REPOSITORY_JDBC_ENABLEDEnable JDBC repositorytrue
GitHubEdit on GitHub

Platform Overview

ByteChef is an open-source, enterprise-ready platform for API integration and workflow automation.

Observability

Guide for Observability setup.