From 10c7c3adfe4042e3293691469da6664be2cae3c2 Mon Sep 17 00:00:00 2001 From: velrino Date: Wed, 28 Jan 2026 08:13:12 -0300 Subject: [PATCH] docs: expand .env.example with all supported env vars - Add AI provider API keys (Anthropic, OpenAI, Gemini, Groq, xAI, etc.) - Add messaging channels (Telegram, Discord, Slack, LINE, Teams, etc.) - Add voice call providers (Twilio, Telnyx, Plivo) - Add gateway and system configuration options - Organize by category with clear optional/required indicators - Add legend explaining commented vs uncommented lines --- .env.example | 160 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 155 insertions(+), 5 deletions(-) diff --git a/.env.example b/.env.example index 29652fe46..7625708f3 100644 --- a/.env.example +++ b/.env.example @@ -1,5 +1,155 @@ -# Copy to .env and fill with your Twilio credentials -TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -TWILIO_AUTH_TOKEN=your_auth_token_here -# Must be a WhatsApp-enabled Twilio number, prefixed with whatsapp: -TWILIO_WHATSAPP_FROM=whatsapp:+17343367101 +# ============================================================ +# Moltbot Environment Variables +# Copy to .env and fill with your credentials +# +# Legend: +# - Uncommented lines = commonly used (fill as needed) +# - Commented lines (#) = optional / advanced use cases +# ============================================================ + +# ------------------------------------------------------------ +# AI Provider API Keys (choose at least one) +# ------------------------------------------------------------ + +# Anthropic (Claude) - Primary provider +ANTHROPIC_API_KEY=sk-ant-xxx +# ANTHROPIC_OAUTH_TOKEN= # Optional: OAuth token instead of API key + +# OpenAI +OPENAI_API_KEY=sk-xxx + +# Google Gemini +GEMINI_API_KEY=AIzaSyxxx + +# Optional: Additional AI Providers +# GROQ_API_KEY=gsk_xxx +# XAI_API_KEY=xai-xxx +# ZAI_API_KEY=zai-xxx +# OPENROUTER_API_KEY=sk-or-xxx +# AI_GATEWAY_API_KEY=xxx +# CEREBRAS_API_KEY=xxx +# MISTRAL_API_KEY=xxx +# MOONSHOT_API_KEY=xxx +# KIMICODE_API_KEY=xxx +# MINIMAX_API_KEY=xxx +# VENICE_API_KEY=xxx +# SYNTHETIC_API_KEY=xxx +# OPENCODE_API_KEY=xxx +# CHUTES_API_KEY=xxx + +# ------------------------------------------------------------ +# GitHub Copilot (Optional) +# ------------------------------------------------------------ +# COPILOT_GITHUB_TOKEN=ghp_xxx +# GH_TOKEN=ghp_xxx # Alternative +# GITHUB_TOKEN=ghp_xxx # Alternative + +# ------------------------------------------------------------ +# AWS Bedrock (Optional) +# ------------------------------------------------------------ +# AWS_ACCESS_KEY_ID=xxx +# AWS_SECRET_ACCESS_KEY=xxx +# AWS_PROFILE=default +# AWS_REGION=us-east-1 + +# ------------------------------------------------------------ +# TTS / Voice Services (Optional) +# ------------------------------------------------------------ +# ELEVENLABS_API_KEY=xxx +# DEEPGRAM_API_KEY=xxx +# OPENAI_TTS_BASE_URL=https://api.openai.com/v1 + +# ------------------------------------------------------------ +# Web Search (Optional) +# ------------------------------------------------------------ +# BRAVE_API_KEY=BSAxxx + +# ------------------------------------------------------------ +# Messaging Channels (configure channels you want to use) +# ------------------------------------------------------------ + +# Telegram (Optional) +# TELEGRAM_BOT_TOKEN=123456789:ABCxxx + +# Discord (Optional) +# DISCORD_BOT_TOKEN=xxx + +# Slack (Optional) +# SLACK_BOT_TOKEN=xoxb-xxx +# SLACK_APP_TOKEN=xapp-xxx + +# LINE (Optional) +# LINE_CHANNEL_ACCESS_TOKEN=xxx +# LINE_CHANNEL_SECRET=xxx + +# Microsoft Teams (Optional) +# MSTEAMS_APP_ID=xxx +# MSTEAMS_APP_PASSWORD=xxx +# MSTEAMS_TENANT_ID=xxx + +# Matrix (Optional) +# MATRIX_HOMESERVER=https://matrix.org +# MATRIX_USER_ID=@user:matrix.org +# MATRIX_ACCESS_TOKEN=xxx + +# Mattermost (Optional) +# MATTERMOST_BOT_TOKEN=xxx +# MATTERMOST_URL=https://mattermost.example.com + +# Zalo Bot (Optional) +# ZALO_BOT_TOKEN=xxx + +# Nextcloud Talk (Optional) +# NEXTCLOUD_TALK_BOT_SECRET=xxx + +# Twitch (Optional) +# CLAWDBOT_TWITCH_ACCESS_TOKEN=oauth:xxx + +# ------------------------------------------------------------ +# Voice Call Providers (Optional) +# ------------------------------------------------------------ + +# Twilio (WhatsApp, Voice) +# TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +# TWILIO_AUTH_TOKEN=your_auth_token_here +# TWILIO_WHATSAPP_FROM=whatsapp:+17343367101 # WhatsApp-enabled number + +# Telnyx +# TELNYX_API_KEY=KEY_xxx +# TELNYX_CONNECTION_ID=xxx + +# Plivo +# PLIVO_AUTH_ID=MAxxxx +# PLIVO_AUTH_TOKEN=xxx + +# ------------------------------------------------------------ +# Tunnel / Ngrok (Optional - for webhooks) +# ------------------------------------------------------------ +# NGROK_AUTHTOKEN=xxx +# NGROK_DOMAIN=your-domain.ngrok.io + +# ------------------------------------------------------------ +# Gateway Configuration (Optional - advanced) +# ------------------------------------------------------------ +# CLAWDBOT_GATEWAY_TOKEN=xxx +# CLAWDBOT_GATEWAY_PASSWORD=xxx +# CLAWDBOT_GATEWAY_PORT=18789 +# CLAWDBOT_GATEWAY_BIND=loopback + +# ------------------------------------------------------------ +# Custom Paths (Optional - advanced) +# ------------------------------------------------------------ +# CLAWDBOT_CONFIG_PATH=~/.clawdbot/moltbot.json +# CLAWDBOT_STATE_DIR=~/.clawdbot +# CLAWDBOT_AGENT_DIR=~/.clawdbot/agents + +# ------------------------------------------------------------ +# OpenTelemetry Diagnostics (Optional - advanced) +# ------------------------------------------------------------ +# OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318 +# OTEL_SERVICE_NAME=moltbot + +# ------------------------------------------------------------ +# Google Cloud / Vertex AI (Optional) +# ------------------------------------------------------------ +# GOOGLE_CLOUD_PROJECT=your-project-id