Skip to content

AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.

20.2 KB
Raw Blame
# Backend Configuration
# This file contains environment variables that MUST be set for the AutoGPT platform
# Variables with working defaults in settings.py are not included here

## ===== REQUIRED DATABASE CONFIGURATION ===== ##
# PostgreSQL Database Connection
DB_USER=postgres
DB_PASS=your-super-secret-and-long-postgres-password
DB_NAME=postgres
DB_PORT=5432
DB_HOST=localhost
DB_CONNECTION_LIMIT=12
DB_CONNECT_TIMEOUT=60
DB_POOL_TIMEOUT=300
DB_SCHEMA=platform
DATABASE_URL="postgresql://${DB_USER}:${DB_PASS}@${DB_HOST}:${DB_PORT}/${DB_NAME}?schema=${DB_SCHEMA}&connect_timeout=${DB_CONNECT_TIMEOUT}"
DIRECT_URL="postgresql://${DB_USER}:${DB_PASS}@${DB_HOST}:${DB_PORT}/${DB_NAME}?schema=${DB_SCHEMA}&connect_timeout=${DB_CONNECT_TIMEOUT}"
PRISMA_SCHEMA="postgres/schema.prisma"

## ===== REQUIRED SERVICE CREDENTIALS ===== ##
# Redis Configuration
REDIS_HOST=localhost
REDIS_PORT=17000
# REDIS_PASSWORD=

# RabbitMQ Credentials
RABBITMQ_DEFAULT_USER=rabbitmq_user_default
RABBITMQ_DEFAULT_PASS=k0VMxyIJF9S35f3x2uaw5IWAl6Y536O7

# Authentication
# JWKS endpoint of the Better Auth service embedded in the frontend.
# Asymmetric (ES256) JWTs are verified against the keys published here.
#
# Transport security: the backend trusts whatever signing keys this URL returns,
# so the fetch must run over a trusted path. Plain http is fine for localhost and
# for container-to-container traffic on a single host (e.g. the default
# http://frontend:3000 over the Docker network). Over an UNTRUSTED network
# (backend and frontend on separate LAN machines, or a public host) use https:
# a cleartext fetch there lets a network attacker substitute the keys and forge
# tokens. For LAN setups, put the frontend behind TLS or use locally-trusted
# certs (e.g. mkcert). See the self-hosting guide's security note.
JWT_JWKS_URL=http://localhost:3000/api/auth/jwks
# The backend refuses to start if JWT_JWKS_URL is cleartext http:// to a
# non-local host, since an attacker in the path could substitute the keys and
# forge tokens. Set this to true to boot anyway on a trusted network path
# (a startup warning stays on record).
# JWKS_ALLOW_INSECURE_TRANSPORT=false

## ===== REQUIRED SECURITY KEYS ===== ##
# Left blank on purpose. This file is public, so any value committed here is a
# published value: the keys that used to sit below are readable by anyone and
# must never be used again. `make init-env` fills each blank with a secret
# generated for your machine when it creates backend/.env, and never overwrites
# a value you set yourself. The backend refuses to start without ENCRYPTION_KEY.
# To make one by hand: from cryptography.fernet import Fernet;Fernet.generate_key().decode()
ENCRYPTION_KEY=
UNSUBSCRIBE_SECRET_KEY=
# The key the backend's services require from each other on every internal
# call; every service needs the same one. Left blank, it is derived from
# ENCRYPTION_KEY.
INTERNAL_API_KEY=

# Web Push (VAPID) — generate with: poetry run python -c "
#   from py_vapid import Vapid; import base64
#   from cryptography.hazmat.primitives.serialization import Encoding, PublicFormat
#   v = Vapid(); v.generate_keys()
#   raw_priv = v.private_key.private_numbers().private_value.to_bytes(32, 'big')
#   print('VAPID_PRIVATE_KEY=' + base64.urlsafe_b64encode(raw_priv).rstrip(b'=').decode())
#   raw_pub = v.public_key.public_bytes(Encoding.X962, PublicFormat.UncompressedPoint)
#   print('VAPID_PUBLIC_KEY=' + base64.urlsafe_b64encode(raw_pub).rstrip(b'=').decode())
# "
# Dev-only keypair below — DO NOT use in staging/production. Regenerate
# your own with the snippet above before any non-local deployment.
VAPID_PRIVATE_KEY=17hBPdSdn6TR_yAgQxA0TjTcvRj3Lf6znHnASZ4rOKc
VAPID_PUBLIC_KEY=BBg49iVTWthVbRYphwmZNvZyiSJDqtSO4nmLxDzLKe3Oo9jbtu0Usa14xX4HQQNLUeiEfzD42zWSlrvY1PR12bs
# Per RFC 8292 push services use this in 410 Gone reports; set to a real
# mailbox in production. Defaults to a placeholder for local dev.
VAPID_CLAIM_EMAIL=mailto:[email protected]

## ===== IMPORTANT OPTIONAL CONFIGURATION ===== ##
# Platform URLs (set these for webhooks and OAuth to work)
PLATFORM_BASE_URL=http://localhost:8006
FRONTEND_BASE_URL=http://localhost:3000
# Extra frontend origins (beyond FRONTEND_BASE_URL) that auth-email action
# links may target — JSON list of full origins or "regex:"-prefixed patterns,
# same format as BACKEND_CORS_ALLOW_ORIGINS. Self-hosting needs nothing here.
# TRUSTED_FRONTEND_ORIGINS=["regex:https://autogpt-pr-\\d+\\.vercel\\.app"]

# Optional split GCS buckets. Public media contains only explicitly published
# marketplace assets and OAuth app logos. Private storage contains user media,
# workspaces, transcripts, and temporary uploads. MEDIA_GCS_BUCKET_NAME remains
# a backwards-compatible fallback for self-hosted single-bucket deployments.
MEDIA_GCS_BUCKET_NAME=
PUBLIC_SITE_MEDIA_BUCKET=
PRIVATE_USER_DATA_BUCKET=

## ===== API KEYS AND OAUTH CREDENTIALS ===== ##
# All API keys below are optional - only add what you need

# AI/LLM Services
OPENAI_API_KEY=
# Image-edit model for Expert avatar candidates (requires the OpenAI key above).
# The design system pins this dated snapshot; any override must support image
# edits with several reference images and opaque PNG output.
EXPERT_AVATAR_MODEL=gpt-image-2-2026-04-21
ANTHROPIC_API_KEY=
GROQ_API_KEY=
LLAMA_API_KEY=
AIML_API_KEY=
V0_API_KEY=
OPEN_ROUTER_API_KEY=
# AutoPilot action supervisor first stage (optional; the LLM judges alone without it)
TYPESAFE_API_KEY=
NVIDIA_API_KEY=

# AutoPilot — self-hosted LLM (Ollama et al.)
# Set CHAT_USE_LOCAL=true to route AutoPilot through an OpenAI-compatible
# endpoint instead of OpenRouter / Anthropic. CHAT_BASE_URL must point at
# the local server (e.g. http://host.docker.internal:11434/v1 for Ollama
# running on the Docker host) and CHAT_API_KEY can be any non-empty string
# — Ollama doesn't validate it. The CHAT_*_MODEL fields must be set to
# bare model names served by the local backend (e.g. llama3.2:3b);
# OpenRouter-style provider/model slugs do not resolve. Extended-thinking
# mode is automatically downgraded to fast under this transport because
# the Claude Agent SDK CLI requires Anthropic's wire protocol.
# Note: on the managed cloud platform (BEHAVE_AS=cloud) CHAT_*_MODEL is
# the BOTTOM layer of AutoPilot model resolution — the LLM catalog's
# copilot routing cells (backend/data/llm_registry/catalog.py) and the
# per-user LaunchDarkly "copilot-model-routing" flag take precedence
# when set. On self-hosted installs the catalog cells are skipped and
# these env vars stay authoritative. See
# docs/platform/contributing/managing-llm-models.md.
CHAT_API_KEY=
CHAT_BASE_URL=
CHAT_USE_LOCAL=false

# Graphiti Temporal Knowledge Graph Memory
# Available when the required memory services and models are configured.
# LLM key falls back to CHAT_API_KEY (AutoPilot), then OPEN_ROUTER_API_KEY,
# then (under CHAT_USE_LOCAL=true) the chat-config api_key + base_url.
# Embedder key falls back to CHAT_OPENAI_API_KEY (AutoPilot), then
# OPENAI_API_KEY, then (local) the chat-config api_key.
#
# Under CHAT_USE_LOCAL=true these defaults are auto-rewritten to local-
# friendly Ollama slugs by GraphitiConfig._apply_local_graphiti_models:
#   GRAPHITI_LLM_MODEL=hf.co/ornith-ai/Ornith-1.5-9B-GGUF:Q4_K_M (same as chat)
#   GRAPHITI_RERANKER_MODEL=hf.co/ornith-ai/Ornith-1.5-9B-GGUF:Q4_K_M
#   GRAPHITI_EMBEDDER_MODEL=nomic-embed-text (needs ollama pull)
# Set GRAPHITI_*_MODEL to a non-cloud slug to bypass the auto-rewrite
# (your custom value passes through untouched). See
# docs/platform/copilot-local-llm.md#dream-pass-and-memory.
GRAPHITI_FALKORDB_HOST=localhost
GRAPHITI_FALKORDB_PORT=6380
GRAPHITI_FALKORDB_PASSWORD=local-dev-password
GRAPHITI_LLM_MODEL=gpt-6-luna
GRAPHITI_EMBEDDER_MODEL=text-embedding-3-small
GRAPHITI_SEMAPHORE_LIMIT=5

# Langfuse Prompt Management
# Used for managing the CoPilot system prompt externally
# Get credentials from https://cloud.langfuse.com or your self-hosted instance
LANGFUSE_PUBLIC_KEY=
LANGFUSE_SECRET_KEY=
LANGFUSE_HOST=https://cloud.langfuse.com

# OAuth Credentials
# For the OAuth callback URL, use <your_frontend_url>/auth/integrations/oauth_callback,
# e.g. http://localhost:3000/auth/integrations/oauth_callback

# GitHub OAuth App server credentials - https://github.com/settings/developers
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=

# Notion OAuth App server credentials - https://developers.notion.com/docs/authorization
# Configure a public integration
NOTION_CLIENT_ID=
NOTION_CLIENT_SECRET=

# Google OAuth App server credentials - https://console.cloud.google.com/apis/credentials, and enable gmail api and set scopes
# https://console.cloud.google.com/apis/credentials/consent ?project=<your_project_id>
# You'll need to add/enable the following scopes (minimum):
# https://console.developers.google.com/apis/api/gmail.googleapis.com/overview ?project=<your_project_id>
# https://console.cloud.google.com/apis/library/sheets.googleapis.com/ ?project=<your_project_id>
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=

# Twitter (X) OAuth 2.0 with PKCE Configuration
# 1. Create a Twitter Developer Account:
#    - Visit https://developer.x.com/en and sign up
# 2. Set up your application:
#    - Navigate to Developer Portal > Projects > Create Project
#    - Add a new app to your project
# 3. Configure app settings:
#    - App Permissions: Read + Write + Direct Messages
#    - App Type: Web App, Automated App or Bot
#    - OAuth 2.0 Callback URL: http://localhost:3000/auth/integrations/oauth_callback
#    - Save your Client ID and Client Secret below
TWITTER_CLIENT_ID=
TWITTER_CLIENT_SECRET=

# Linear App
# Make a new workspace for your OAuth APP -- trust me
# https://linear.app/settings/api/applications/new
# Callback URL: http://localhost:3000/auth/integrations/oauth_callback
LINEAR_API_KEY=
# Linear project and team IDs for the feature request tracker.
# Find these in your Linear workspace URL: linear.app/<workspace>/project/<project-id>
# and in team settings. Used by the chat copilot to file and search feature requests.
LINEAR_FEATURE_REQUEST_PROJECT_ID=
LINEAR_FEATURE_REQUEST_TEAM_ID=
LINEAR_CLIENT_ID=
LINEAR_CLIENT_SECRET=

# Slack app for signing in to Slack's MCP server (mcp.slack.com), which does not
# support dynamic client registration
SLACK_MCP_CLIENT_ID=
SLACK_MCP_CLIENT_SECRET=

# HubSpot MCP auth app for signing in to HubSpot's MCP server (mcp.hubspot.com),
# which does not support dynamic client registration
HUBSPOT_MCP_CLIENT_ID=
HUBSPOT_MCP_CLIENT_SECRET=

# To obtain Todoist API credentials:
# 1. Create a Todoist account at todoist.com
# 2. Visit the Developer Console: https://developer.todoist.com/appconsole.html
# 3. Click "Create new app"
# 4. Once created, copy your Client ID and Client Secret below
TODOIST_CLIENT_ID=
TODOIST_CLIENT_SECRET=

NOTION_CLIENT_ID=
NOTION_CLIENT_SECRET=

# Discord OAuth App credentials
# 1. Go to https://discord.com/developers/applications
# 2. Create a new application
# 3. Go to OAuth2 section and add redirect URI: http://localhost:3000/auth/integrations/oauth_callback
# 4. Copy Client ID and Client Secret below
DISCORD_CLIENT_ID=
DISCORD_CLIENT_SECRET=

REDDIT_CLIENT_ID=
REDDIT_CLIENT_SECRET=

# Payment Processing
STRIPE_API_KEY=
STRIPE_WEBHOOK_SECRET=

# Email Service (for sending notifications and confirmations)
# Better Auth password-reset / verification emails also send through this
# Postmark mailer via POST /api/auth-email/send, authenticated by short-lived
# frontend service tokens verified against JWT_JWKS_URL — no extra secret.
POSTMARK_SERVER_API_TOKEN=
[email protected]
POSTMARK_WEBHOOK_TOKEN=

# Senders are separated so subscription mail, product notifications and
# internal ops mail each carry their own reputation. Alerts and Briefings must
# go out on a transactional stream, separate from marketing mail.
BILLING_SENDER_EMAIL=AutoGPT <[email protected]>
PRODUCT_SENDER_EMAIL=AutoGPT <[email protected]>
[email protected]
[email protected]
OPS_SENDER_EMAIL=AutoGPT Platform <[email protected]>
POSTMARK_TRANSACTIONAL_STREAM=outbound
# Track opens and clicks in notification emails (never in auth emails), so the
# Postmark webhook can send email_opened / email_clicked to PostHog.
POSTMARK_TRACK_OPENS_AND_CLICKS=false

# Hero art and the logo are hosted images: Outlook does not render inline SVG
# and Gmail does not display data-URI images. The logo is served from this
# base URL; Otto uses the versioned character library on the same host.
EMAIL_ASSET_BASE_URL=https://platform.agpt.co/email
DOCS_BASE_URL=https://docs.agpt.co
DISCORD_INVITE_URL=https://discord.gg/autogpt
ADMIN_PANEL_BASE_URL=https://admin.agpt.co

# MailerLite owns the six-email onboarding tour and the monthly changelog; the
# backend only manages who is in each audience. See
# backend/notifications/DEPLOYMENT.md for the one-time setup.
MAILERLITE_API_TOKEN=
MAILERLITE_ONBOARDING_GROUP_ID=
MAILERLITE_CHANGELOG_GROUP_ID=
# Customers in a card-required trial. Blank keeps trials out of MailerLite.
MAILERLITE_TRIAL_GROUP_ID=
# Everyone who opened Stripe checkout. Blank keeps them out of MailerLite.
MAILERLITE_CHECKOUT_GROUP_ID=
# Secret of the MailerLite webhook for subscriber.unsubscribed, which points at
# /api/email/mailerlite/webhook. Blank refuses every call to it.
MAILERLITE_WEBHOOK_SECRET=

# Error Tracking
SENTRY_DSN=
# Git sha reported as the Sentry release. Unset reports no release.
# SENTRY_RELEASE=
# Replaces the app:<env>-behave:<mode> environment Sentry events are tagged
# with, e.g. pr-123 for a preview. Unset keeps the computed one.
# SENTRY_ENVIRONMENT=

# Feature Flags
LAUNCH_DARKLY_SDK_KEY=
# Which vendor answers a flag read: posthog (default), launchdarkly, or dual
# (evaluate both, always serve LaunchDarkly here, log every disagreement).
# Without POSTHOG_API_KEY every flag reads as its code default.
FEATURE_FLAG_BACKEND=posthog
# Local-dev master switch: turn EVERY boolean feature flag on at once, without
# listing them. Off by default; local dev only, where no flag vendor is
# configured and every flag is otherwise its default. A per-flag FORCE_FLAG_<NAME>
# below still wins, so one flag can be excluded with =false. Non-boolean flags
# (stripe-product-id-topup, copilot-model-routing, the copilot tier/cost JSON
# flags) are left to the flag vendor. Ignored, with an error log, unless
# APP_ENV=local -- `dev` and `prod` are real deployments, not a developer's
# machine. That includes the single-container image, whose entrypoint exports
# APP_ENV=dev; use the per-flag FORCE_FLAG_<NAME> below there instead. Set the
# matching NEXT_PUBLIC_FORCE_ALL_FLAGS in frontend/.env for the UI.
# Left commented: .env.default ships to every install.
# FORCE_ALL_FLAGS=true

# Content Generation & Media
DID_API_KEY=
FAL_API_KEY=
IDEOGRAM_API_KEY=
REPLICATE_API_KEY=
SCREENSHOTONE_API_KEY=
UNREAL_SPEECH_API_KEY=
ELEVENLABS_API_KEY=

# Data & Search Services
ANYSEARCH_API_KEY=
E2B_API_KEY=
# host:port of the credential swap proxy every E2B box egresses through
# (backend.util.e2b_network). Leave empty until the proxy exists: E2B fails
# closed, so a box pointed at nothing has no egress at all.
E2B_EGRESS_PROXY_ADDRESS=
EXA_API_KEY=
JINA_API_KEY=
MEM0_API_KEY=
OPENWEATHERMAP_API_KEY=
TAVILY_API_KEY=
GOOGLE_MAPS_API_KEY=

# Platform Bot Linking
PLATFORM_LINK_BASE_URL=http://localhost:3000/link

# CoPilot chat-platform bridge (Discord/Telegram/Slack/Teams)
# Uses FRONTEND_BASE_URL (above) for link confirmation pages.
AUTOPILOT_BOT_DISCORD_TOKEN=
# Slack adapter — set the signing secret + client id/secret to mount the Slack
# webhook routes and the multi-workspace "Add to Slack" install flow. The static
# token is an optional fallback for the app's own (dev) workspace; installs from
# other workspaces obtain their own per-team token via OAuth.
AUTOPILOT_BOT_SLACK_CLIENT_ID=
AUTOPILOT_BOT_SLACK_CLIENT_SECRET=
AUTOPILOT_BOT_SLACK_SIGNING_SECRET=
AUTOPILOT_BOT_SLACK_TOKEN=
# Telegram adapter — set the BotFather token + a webhook secret of your choice
# to mount the Telegram webhook route, then register the webhook once:
#   curl "https://api.telegram.org/bot<TOKEN>/setWebhook" #     -d "url=<PLATFORM_BASE_URL>/api/copilot-webhooks/telegram/updates" #     -d "secret_token=<AUTOPILOT_BOT_TELEGRAM_WEBHOOK_SECRET>" #     -d "allowed_updates=[\"message\",\"my_chat_member\"]"
# The username (without @) powers the "Add bot to Telegram" t.me link.
AUTOPILOT_BOT_TELEGRAM_TOKEN=
AUTOPILOT_BOT_TELEGRAM_USERNAME=
AUTOPILOT_BOT_TELEGRAM_WEBHOOK_SECRET=
# Teams adapter — set all three (Azure Bot app id, client secret, tenant id) to
# mount the Teams webhook route, and point the bot's messaging endpoint at
# <PLATFORM_BASE_URL>/api/copilot-webhooks/teams/messages. Tenant id is
# mandatory: new registrations are single-tenant only since 2025-07-31. In
# channels the bot only sees messages that @mention it — commands included,
# e.g. "@AutoGPT /setup".
# Public Entra application ID used by Microsoft 365 Copilot device auth and,
# when the server-only values below are set, by the Teams bot adapter.
MICROSOFT_CLIENT_ID=ce01a4d6-be71-42a0-86b1-6540838eb17c
MICROSOFT_CLIENT_SECRET=
MICROSOFT_TENANT_ID=
# Local only: accept unsigned activities so the M365 Agents Playground (which
# sends no JWT) works without a tenant or tunnel. Also requires APP_ENV=local.
AUTOPILOT_BOT_TEAMS_ALLOW_UNVERIFIED=false

# Communication Services
DISCORD_BOT_TOKEN=
MEDIUM_API_KEY=
MEDIUM_AUTHOR_ID=
SMTP_SERVER=
SMTP_PORT=
SMTP_USERNAME=
SMTP_PASSWORD=

# Business & Marketing Tools
AGENTMAIL_API_KEY=
APOLLO_API_KEY=
ENRICHLAYER_API_KEY=
AYRSHARE_API_KEY=
AYRSHARE_JWT_KEY=
SMARTLEAD_API_KEY=
ZEROBOUNCE_API_KEY=

# PostHog Analytics
# Get API key from https://posthog.com - Project Settings > Project API Key
POSTHOG_API_KEY=
POSTHOG_HOST=https://eu.i.posthog.com
# Feature Flags Secure API Key, only for local feature-flag evaluation (project
# settings > Feature Flags). A personal API key also works, but PostHog is
# deprecating that use. Without it flag reads go over the wire.
POSTHOG_SECRET_KEY=
# Where flag definitions are shared between processes: redis (default; one
# elected refresher, every other process reads its copy), memory (process-local),
# or none (every process polls PostHog itself). PostHog bills one definitions
# fetch as ten flag requests, so "none" scales that bill with replica count.
POSTHOG_FLAG_DEFINITION_CACHE=redis
POSTHOG_FLAG_DEFINITION_REFRESH_SECONDS=30
POSTHOG_FLAG_DEFINITION_CACHE_TTL_SECONDS=600

# Usage telemetry that graphiti-core and mem0 send to their vendors' own
# analytics. The backend turns both off when these are unset. To opt in, set
# true in the process environment (compose env_file or an export); a value
# only in backend/.env is ignored for local `poetry run` starts.
GRAPHITI_TELEMETRY_ENABLED=false
MEM0_TELEMETRY=false

# Tally Form Integration (pre-populate business understanding on signup)
TALLY_API_KEY=

# Other Services
# All Quiet incident management / on-call. The Public API is only available on
# the PRO and ENTERPRISE plans; generate the key in your organization settings.
ALLQUIET_API_KEY=
AUTOMOD_API_KEY=

# RMFG (sheet-metal & tube-laser manufacturing)
RMFG_API_KEY=

## ===== ONBOARDING BRAIN DUMP ===== ##
# Speech-to-text model for the brain dump. Requires a direct OpenAI key
# (OPENAI_INTERNAL_API_KEY, else OPENAI_API_KEY) — OpenRouter has no
# /audio/transcriptions endpoint. Falls back automatically on failure.
# BRAIN_DUMP_TRANSCRIPTION_MODEL=gpt-4o-transcribe
# BRAIN_DUMP_TRANSCRIPTION_FALLBACK_MODEL=whisper-1

# Greeting generation for the copilot home after onboarding. The prompt is
# managed in Langfuse under BRAIN_DUMP_GREETING_PROMPT_NAME when Langfuse
# credentials are configured; otherwise a built-in prompt is used.
# BRAIN_DUMP_GREETING_MODEL=anthropic/claude-sonnet-5-5
# BRAIN_DUMP_GREETING_PROMPT_NAME=Brain Dump Greeting

# Model that picks which integrations to suggest in the welcome dialog's
# "Connect your tools" panel. Recommendations are best-effort — a failure
# here never blocks onboarding.
# BRAIN_DUMP_RECOMMEND_MODEL=anthropic/claude-sonnet-5

# Skills catalog publisher (poetry run publish-skills-catalog), which runs after
# every migrate deploy and puts the catalog's skills and expert roster on the
# marketplace. Downloads the public catalog repo; a local checkout skips that.
# The token is optional and only raises the GitHub API rate limit.
# SKILLS_CATALOG_REPO=Significant-Gravitas/skills-catalog
# SKILLS_CATALOG_REF=main
# SKILLS_CATALOG_TOKEN=
# SKILLS_CATALOG_PATH=