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.
Environment Variable Description Default Value BYTECHEF_AI_COPILOT_ENABLEDEnable or disable the AI copilot feature falseBYTECHEF_AI_COPILOT_PROVIDERThe AI provider to use for copilot (OPENAI, ANTHROPIC) ANTHROPIC
Environment Variable Description Default Value BYTECHEF_AI_FIRECRAWL_APIKEYFirecrawl API key (sensitive) - BYTECHEF_AI_FIRECRAWL_BASEURLFirecrawl API base URL https://api.firecrawl.dev/v2BYTECHEF_AI_FIRECRAWL_ENABLEDEnable or disable Firecrawl false
Environment Variable Description Default Value BYTECHEF_AI_KNOWLEDGEBASE_ENABLEDEnable or disable knowledge base AI features falseBYTECHEF_AI_KNOWLEDGEBASE_OCR_PROVIDEROCR provider for knowledge base documents (NONE, AZURE, MISTRAL) NONEBYTECHEF_AI_KNOWLEDGEBASE_OCR_MISTRAL_APIKEYMistral OCR API key (sensitive) - BYTECHEF_AI_KNOWLEDGEBASE_SUBSCRIPTIONS_DOCUMENT_PROCESS_EVENTSNumber of subscribers for document process events 1BYTECHEF_AI_KNOWLEDGEBASE_SUBSCRIPTIONS_DOCUMENT_CHUNK_UPDATE_EVENTSNumber of subscribers for document chunk update events 1
Environment Variable Description Default Value BYTECHEF_AI_MCP_SERVER_ENABLEDEnable or disable the MCP (Model Context Protocol) server false
Environment Variable Description Default Value BYTECHEF_AI_MEMORY_PROVIDERMemory storage provider for chat-style interactions (AWS, IN_MEMORY, JDBC, REDIS) JDBC
Environment Variable Description Default Value BYTECHEF_AI_PROVIDER_ANTHROPIC_APIKEYAnthropic API key (sensitive) - BYTECHEF_AI_PROVIDER_AZURE_OPENAI_APIKEYAzure OpenAI API key (sensitive) - BYTECHEF_AI_PROVIDER_DEEP_SEEK_APIKEYDeepSeek API key (sensitive) - BYTECHEF_AI_PROVIDER_GROQ_APIKEYGroq API key (sensitive) - BYTECHEF_AI_PROVIDER_MISTRAL_APIKEYMistral API key (sensitive) - BYTECHEF_AI_PROVIDER_NVIDIA_APIKEYNVIDIA API key (sensitive) - BYTECHEF_AI_PROVIDER_OPENAI_APIKEYOpenAI API key (sensitive) - BYTECHEF_AI_PROVIDER_PERPLEXITY_APIKEYPerplexity API key (sensitive) - BYTECHEF_AI_PROVIDER_STABILITY_APIKEYStability API key (sensitive) - BYTECHEF_AI_PROVIDER_VERTEX_GEMINI_APIKEYVertex Gemini API key (sensitive) -
Environment Variable Description Default Value BYTECHEF_AI_PROVIDER_CHAT_ANTHROPIC_OPTIONS_MODELAnthropic chat model name claude-sonnet-4-6BYTECHEF_AI_PROVIDER_CHAT_ANTHROPIC_OPTIONS_TEMPERATUREAnthropic chat temperature (0.0-1.0) 0.5BYTECHEF_AI_PROVIDER_CHAT_OPENAI_OPTIONS_MODELOpenAI chat model name gpt-5.1BYTECHEF_AI_PROVIDER_CHAT_OPENAI_OPTIONS_TEMPERATUREOpenAI chat temperature (0.0-2.0) 1BYTECHEF_AI_PROVIDER_CHAT_OPENAI_OPTIONS_REASONINGEFFECTOpenAI reasoning effect (NONE, LOW, MEDIUM, HIGH) MEDIUMBYTECHEF_AI_PROVIDER_CHAT_OPENAI_OPTIONS_VERBOSITYOpenAI response verbosity (NONE, LOW, MEDIUM, HIGH) LOW
Environment Variable Description Default Value BYTECHEF_AI_PROVIDER_EMBEDDING_OPENAI_OPTIONS_MODELOpenAI embedding model name text-embedding-3-small
Environment Variable Description Default Value BYTECHEF_AI_VECTORSTORE_PROVIDERVector store provider (PGVECTOR) PGVECTORBYTECHEF_AI_VECTORSTORE_PGVECTOR_URLJDBC URL for the pgvector PostgreSQL database - BYTECHEF_AI_VECTORSTORE_PGVECTOR_USERNAMEpgvector database username (sensitive) - BYTECHEF_AI_VECTORSTORE_PGVECTOR_PASSWORDpgvector database password (sensitive) -
Environment Variable Description Default Value BYTECHEF_ANALYTICS_ENABLEDEnable or disable analytics false
Environment Variable Description Default Value BYTECHEF_CACHE_PROVIDERCache provider (REDIS, CAFFEINE) CAFFEINE
Environment Variable Description Default Value BYTECHEF_CLOUD_PROVIDERCloud provider (AWS, NONE) NONEBYTECHEF_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 -
Environment Variable Description Default Value BYTECHEF_COMPONENT_REGISTRY_EXCLUDEList of components to exclude from registry -
Environment Variable Description Default Value BYTECHEF_COORDINATOR_ENABLEDEnable or disable the coordinator true
Environment Variable Description Default Value BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_APPLICATION_EVENTSNumber of application event subscribers 1BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_RESUME_JOB_EVENTSNumber of resume job event subscribers 1BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_START_JOB_EVENTSNumber of start job event subscribers 1BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_STOP_JOB_EVENTSNumber of stop job event subscribers 1BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_TASK_EXECUTION_COMPLETE_EVENTSNumber of task execution complete event subscribers 1BYTECHEF_COORDINATOR_TASK_SUBSCRIPTIONS_TASK_EXECUTION_ERROR_EVENTSNumber of task execution error event subscribers 1
Environment Variable Description Default Value BYTECHEF_COORDINATOR_TRIGGER_POLLING_CHECKPERIODTrigger polling interval in minutes 5BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_APPLICATION_EVENTSNumber of application event subscribers 1BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_TRIGGER_EXECUTION_COMPLETE_EVENTSNumber of trigger execution complete event subscribers 1BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_TRIGGER_EXECUTION_ERROR_EVENTSNumber of trigger execution error event subscribers 1BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_TRIGGER_LISTENER_EVENTSNumber of trigger listener event subscribers 1BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_TRIGGER_POLL_EVENTSNumber of trigger poll event subscribers 1BYTECHEF_COORDINATOR_TRIGGER_SUBSCRIPTIONS_TRIGGER_WEBHOOK_EVENTSNumber of trigger webhook event subscribers 1
Environment Variable Description Default Value BYTECHEF_DATASOURCE_URLDatabase URL - BYTECHEF_DATASOURCE_USERNAMEDatabase username (sensitive) - BYTECHEF_DATASOURCE_PASSWORDDatabase password (sensitive) -
Environment Variable Description Default Value BYTECHEF_DATASTORAGE_PROVIDERData storage provider (AWS, FILESYSTEM, JDBC) JDBC
Environment Variable Description Default Value BYTECHEF_DISCOVERY_SERVICE_PROVIDERDiscovery service provider (REDIS) REDIS
Environment Variable Description Default Value BYTECHEF_EDITIONByteChef edition (CE, EE) EE
Environment Variable Description Default Value BYTECHEF_ENVIRONMENTRestrict the instance to a single environment (DEVELOPMENT, STAGING, PRODUCTION) -
Environment Variable Description Default Value BYTECHEF_ENCRYPTION_PROVIDEREncryption provider (FILESYSTEM, PROPERTY) FILESYSTEMBYTECHEF_ENCRYPTION_PROPERTY_KEYEncryption key (sensitive) -
Environment Variable Description Default Value BYTECHEF_FEATUREFLAGSList of enabled feature flags -
Environment Variable Description Default Value BYTECHEF_FILESTORAGE_PROVIDERFile storage provider (AWS, FILESYSTEM, JDBC) FILESYSTEMBYTECHEF_FILESTORAGE_FILESYSTEM_BASEDIRBase directory for filesystem storage ${user.home}/bytechef/data/file-storageBYTECHEF_FILESTORAGE_AWS_BUCKETAWS S3 bucket name -
Environment Variable Description Default Value BYTECHEF_HELPHUB_ENABLEDEnable or disable the help hub false
Environment Variable Description Default Value BYTECHEF_KAFKA_BOOTSTRAP_SERVERSComma-separated list of Kafka bootstrap servers (host:port) - BYTECHEF_KAFKA_CONSUMER_GROUP_IDKafka consumer group identifier -
Environment Variable Description Default Value BYTECHEF_MAIL_AUTHEnable mail authentication falseBYTECHEF_MAIL_BASEURLBase URL for mail links BYTECHEF_PUBLICURLBYTECHEF_MAIL_DEBUGEnable mail debug falseBYTECHEF_MAIL_FROMFrom email address noreply@app.bytechef.ioBYTECHEF_MAIL_HOSTMail server host localhostBYTECHEF_MAIL_PASSWORDMail password (sensitive) - BYTECHEF_MAIL_PORTMail server port 25BYTECHEF_MAIL_PROTOCOLMail protocol smtpBYTECHEF_MAIL_SSL_ENABLEDEnable SSL for mail falseBYTECHEF_MAIL_STARTTLS_ENABLEEnable STARTTLS falseBYTECHEF_MAIL_STARTTLS_REQUIREDRequire STARTTLS falseBYTECHEF_MAIL_USERNAMEMail username (sensitive) -
Environment Variable Description Default Value BYTECHEF_MESSAGEBROKER_PROVIDERMessage broker provider (AMQP, AWS, JMS, KAFKA, MEMORY, REDIS) MEMORY
Environment Variable Description Default Value BYTECHEF_OAUTH2_REDIRECT_URIOAuth2 redirect URI BYTECHEF_PUBLICURL/callbackBYTECHEF_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) -
Environment Variable Description Default Value BYTECHEF_PUBLICURLPublic URL of the ByteChef instance http://127.0.0.1:8080
Environment Variable Description Default Value BYTECHEF_RABBITMQ_HOSTRabbitMQ server hostname - BYTECHEF_RABBITMQ_PORTRabbitMQ server port 5672BYTECHEF_RABBITMQ_USERNAMERabbitMQ username (sensitive) - BYTECHEF_RABBITMQ_PASSWORDRabbitMQ password (sensitive) -
Environment Variable Description Default Value BYTECHEF_REDIS_HOSTRedis server hostname - BYTECHEF_REDIS_PORTRedis server port 6379BYTECHEF_REDIS_PASSWORDRedis password (sensitive) - BYTECHEF_REDIS_DATABASERedis database index 0BYTECHEF_REDIS_TIMEOUTConnection timeout in milliseconds 0
Environment Variable Description Default Value BYTECHEF_RESOURCES_WEBWeb resources location file:///opt/bytechef/client/
Environment Variable Description Default 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_SOCIALLOGIN_ENABLEDEnable social login falseBYTECHEF_SECURITY_SOCIALLOGIN_GOOGLE_CLIENTIDGoogle OAuth2 client ID (sensitive) - BYTECHEF_SECURITY_SOCIALLOGIN_GOOGLE_CLIENTSECRETGoogle OAuth2 client secret (sensitive) - BYTECHEF_SECURITY_SOCIALLOGIN_GITHUB_CLIENTIDGitHub OAuth2 client ID (sensitive) - BYTECHEF_SECURITY_SOCIALLOGIN_GITHUB_CLIENTSECRETGitHub OAuth2 client secret (sensitive) - BYTECHEF_SECURITY_SSO_ENABLEDEnable Single Sign-On falseBYTECHEF_SECURITY_TWOFACTORAUTHENTICATION_ENABLEDEnable two-factor authentication falseBYTECHEF_SECURITY_SYSTEM_USERNAMESystem administrator username system_adminBYTECHEF_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.
Environment Variable Description Default Value BYTECHEF_SCHEDULER_PROVIDERScheduler provider (AWS, QUARTZ) QUARTZ
Environment Variable Description Default Value BYTECHEF_SIGNUP_ACTIVATIONREQUIREDRequire account activation falseBYTECHEF_SIGNUP_ENABLEDEnable sign up true
Environment Variable Description Default Value BYTECHEF_TENANT_MODETenant mode (MULTI, SINGLE) SINGLE
Environment Variable Description Default Value BYTECHEF_UPGRADE_ENABLEDRun database upgrades (Liquibase migrations) at startup. Disable on read-only replicas or when only a designated instance should apply schema changes in a multi-instance deployment. true
Environment Variable Description Default Value BYTECHEF_USERGUIDING_ENABLEDEnable or disable user guiding (in-application tutorials) falseBYTECHEF_USERGUIDING_CONTAINER_IDContainer ID for the UserGuiding SDK -
Environment Variable Description Default Value BYTECHEF_WEBHOOKURLWebhook URL BYTECHEF_PUBLICURL/webhooks/{id}
Environment Variable Description Default Value BYTECHEF_OBSERVABILITY_LOGGING_ENABLEDEnable or disable OTel logging falseBYTECHEF_OBSERVABILITY_LOGGING_ENDPOINTOTel logging endpoint URL http://localhost:4318/v1/logsBYTECHEF_OBSERVABILITY_METRICS_ENABLEDEnable or disable OTel metrics falseBYTECHEF_OBSERVABILITY_METRICS_ENDPOINTOTel metrics endpoint URL http://localhost:4318/v1/metricsBYTECHEF_OBSERVABILITY_TRACING_ENABLEDEnable or disable OTel tracing falseBYTECHEF_OBSERVABILITY_TRACING_ENDPOINTOTel tracing endpoint URL http://localhost:4318/v1/traces
Environment Variable Description Default Value BYTECHEF_WORKER_ENABLEDEnable or disable the worker trueBYTECHEF_WORKER_TASK_DEFAULT_TIMEOUTDefault timeout for task execution in milliseconds - BYTECHEF_WORKER_TASK_SUBSCRIPTIONS_DEFAULTNumber of concurrent consumers for the default worker queue 10BYTECHEF_WORKER_TASK_SUBSCRIPTIONS_<QUEUE_NAME>Number of concurrent consumers for an additional worker queue (e.g., captions for tasks routed via node: captions). The queue must be created before tasks can be routed to it; ByteChef creates the queue automatically when the worker bootstraps if it doesn't already exist. -
Environment Variable Description Default Value BYTECHEF_WORKFLOW_OUTPUTSTORAGE_PROVIDEROutput storage provider (AWS, FILESYSTEM, JDBC) JDBC
Environment Variable Description Default Value BYTECHEF_WORKFLOW_REPOSITORY_CLASSPATH_ENABLEDEnable classpath repository falseBYTECHEF_WORKFLOW_REPOSITORY_CLASSPATH_LOCATION_PATTERNClasspath location pattern - BYTECHEF_WORKFLOW_REPOSITORY_FILESYSTEM_ENABLEDEnable filesystem repository falseBYTECHEF_WORKFLOW_REPOSITORY_FILESYSTEM_LOCATION_PATTERNFilesystem location pattern - BYTECHEF_WORKFLOW_REPOSITORY_GIT_ENABLEDEnable Git repository falseBYTECHEF_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 repository true
How is this guide?
Last updated on
