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) OPENAIBYTECHEF_AI_COPILOT_OPENAI_API_KEYOpenAI API key for copilot (sensitive) - BYTECHEF_AI_COPILOT_OPENAI_CHAT_OPTIONS_MODELOpenAI model to use for chat gpt-5.2BYTECHEF_AI_COPILOT_OPENAI_CHAT_OPTIONS_TEMPERATURETemperature setting for OpenAI chat 0.5BYTECHEF_AI_COPILOT_OPENAI_EMBEDDING_OPTIONS_MODELEmbeddings for OpenAI text-embedding-3-small
Environment Variable Description Default 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) -
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_CHECK_PERIODTrigger polling interval in minutes 5BYTECHEF_COORDINATOR_TRIGGER_SCHEDULER_PROVIDERScheduler provider (AWS, QUARTZ) QUARTZBYTECHEF_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_DATA_STORAGE_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_FEATURE_FLAGSList of enabled feature flags -
Environment Variable Description Default Value BYTECHEF_FILE_STORAGE_PROVIDERFile storage provider (AWS, FILESYSTEM, JDBC) FILESYSTEMBYTECHEF_FILE_STORAGE_FILESYSTEM_BASEDIRBase directory for filesystem storage - BYTECHEF_FILE_STORAGE_AWS_BUCKETAWS S3 bucket name -
Environment Variable Description Default Value BYTECHEF_HELP_HUB_ENABLEDEnable or disable the help hub false
Environment Variable Description Default Value BYTECHEF_MAIL_AUTHEnable mail authentication falseBYTECHEF_MAIL_BASE_URLBase URL for mail links BYTECHEF_PUBLIC_URLBYTECHEF_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_MESSAGE_BROKER_PROVIDERMessage broker provider (AMQP, AWS, JMS, KAFKA, MEMORY, REDIS) MEMORY
Environment Variable Description Default Value BYTECHEF_OAUTH2_REDIRECT_URIOAuth2 redirect URI BYTECHEF_PUBLIC_URL/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_PUBLIC_URLPublic URL of the ByteChef instance http://127.0.0.1:8080
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_SOCIAL_LOGIN_ENABLEDEnable social login falseBYTECHEF_SECURITY_SOCIAL_LOGIN_GOOGLE_CLIENT_IDGoogle OAuth2 client ID (sensitive) - BYTECHEF_SECURITY_SOCIAL_LOGIN_GOOGLE_CLIENT_SECRETGoogle OAuth2 client secret (sensitive) - BYTECHEF_SECURITY_SOCIAL_LOGIN_GITHUB_CLIENT_IDGitHub OAuth2 client ID (sensitive) - BYTECHEF_SECURITY_SOCIAL_LOGIN_GITHUB_CLIENT_SECRETGitHub OAuth2 client secret (sensitive) - BYTECHEF_SECURITY_SSO_ENABLEDEnable Single Sign-On falseBYTECHEF_SECURITY_TWO_FACTOR_AUTHENTICATION_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_SIGNUP_ACTIVATION_REQUIREDRequire 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_WEBHOOK_URLWebhook URL BYTECHEF_PUBLIC_URL/webhooks/{id}
Environment Variable Description Default Value BYTECHEF_OBSERVABILITY_ENABLEDEnable or disable OTel metrics, logging and tracing falseBYTECHEF_OBSERVABILITY_LOGGING_ENDPOINTOTel logging endpoint URL http://localhost:4318/v1/logsBYTECHEF_OBSERVABILITY_METRICS_ENDPOINTOTel metrics endpoint URL http://localhost:4318/v1/metricsBYTECHEF_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_SUBSCRIPTIONS_DEFAULTNumber of subscribers for default worker queue 10BYTECHEF_WORKER_TASK_SUBSCRIPTIONS_<EVENT_TYPE>Number of subscribers for specific worker queue -
Environment Variable Description Default Value BYTECHEF_WORKFLOW_OUTPUT_STORAGE_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
