.env.example

# =============================================================================
# Agent Monitor - Environment Variables
# =============================================================================
# Copy this file to .env and fill in the values for your environment.
# All variables are optional — Agent Monitor works with sensible defaults.

# -----------------------------------------------------------------------------
# Server
# -----------------------------------------------------------------------------

# Port the server listens on (default: 3456)
# PORT=3456

# -----------------------------------------------------------------------------
# Agent Binaries
# -----------------------------------------------------------------------------

# Path to the Claude Code CLI binary (default: "claude" from PATH)
# CLAUDE_BIN=claude

# Path to the Codex CLI binary (default: "codex" from PATH)
# CODEX_BIN=codex

# -----------------------------------------------------------------------------
# Dashboard Authentication
# -----------------------------------------------------------------------------
# Set a password to protect the dashboard from unauthorized access.
# When set, users must log in before accessing the dashboard or API.
# If not set, the dashboard is open to anyone who can reach the server.

# DASHBOARD_PASSWORD=

# -----------------------------------------------------------------------------
# Email Notifications (SMTP)
# -----------------------------------------------------------------------------
# Configure these to receive email alerts when an agent needs human interaction.
# If SMTP_HOST is not set, email notifications are disabled and events are
# logged to the server console instead.

# SMTP server hostname (e.g., smtp.gmail.com, smtp.mailgun.org)
# SMTP_HOST=

# SMTP server port (default: 587)
# SMTP_PORT=587

# Use TLS connection — set to "true" for port 465, "false" for STARTTLS on 587
# SMTP_SECURE=false

# SMTP authentication username
# SMTP_USER=

# SMTP authentication password (for Gmail, use an App Password)
# SMTP_PASS=

# "From" address shown in notification emails
# SMTP_FROM=agent-monitor@localhost

# -----------------------------------------------------------------------------
# WhatsApp Notifications (Twilio)
# -----------------------------------------------------------------------------
# Configure these to receive WhatsApp messages when an agent needs attention.
# Requires a Twilio account with WhatsApp sandbox or registered sender.
# See docs: https://www.twilio.com/docs/whatsapp

# Twilio Account SID (from Twilio Console)
# TWILIO_ACCOUNT_SID=

# Twilio Auth Token (from Twilio Console)
# TWILIO_AUTH_TOKEN=

# WhatsApp-enabled Twilio phone number (e.g., +14155238886)
# TWILIO_WHATSAPP_FROM=

# -----------------------------------------------------------------------------
# Slack Notifications (Webhook)
# -----------------------------------------------------------------------------
# Configure this to receive Slack messages when an agent needs attention.
# Create an Incoming Webhook at https://api.slack.com/messaging/webhooks

# Slack Incoming Webhook URL (default global webhook for all agents)
# SLACK_WEBHOOK_URL=

# -----------------------------------------------------------------------------
# Remote Relay (Tunnel)
# -----------------------------------------------------------------------------
# Configure these to connect to a relay server on a public machine,
# allowing access to the dashboard from portable devices (laptop, phone).
# If RELAY_URL is not set, relay mode is disabled (local-only mode).

# WebSocket URL of the relay server (e.g., ws://your-server:3457/tunnel)
# RELAY_URL=

# Shared secret token for tunnel authentication (must match relay server)
# RELAY_TOKEN=

# -----------------------------------------------------------------------------
# Relay Dashboard Authentication
# -----------------------------------------------------------------------------
# Set a password to protect the relay dashboard from public access.
# When set, users must log in before accessing the dashboard or API.
# If not set, the relay dashboard is open to anyone who knows the URL.

# Password for relay dashboard login
# RELAY_PASSWORD=

# -----------------------------------------------------------------------------
# Telegram Bot
# -----------------------------------------------------------------------------
# Configure these to enable Telegram as an interactive interface for your agents.
# Create a bot via @BotFather on Telegram to get the token.
# If TELEGRAM_TOKEN is not set, the Telegram bot is disabled.

# Telegram Bot API token (from @BotFather)
# TELEGRAM_TOKEN=

# Restrict bot to a single chat ID (leave empty to allow all chats)
# TELEGRAM_CHAT_ID=

# -----------------------------------------------------------------------------
# Feishu (Lark) Bot Integration
# -----------------------------------------------------------------------------
# Configure these to enable Feishu as an interactive interface for your agents.
# Create a Feishu bot at https://open.feishu.cn/app and enable:
#   - "Receive messages" and "Send messages" permissions
#   - WebSocket long-connection event subscription
#   - "Interactive card" support (for permission/choice buttons)
# If FEISHU_APP_ID is not set, the Feishu bot is disabled.

# Feishu App ID (from the bot's credentials page)
# FEISHU_APP_ID=

# Feishu App Secret (from the bot's credentials page)
# FEISHU_APP_SECRET=

# Comma-separated list of allowed Feishu open_ids (leave empty to allow all users)
# FEISHU_ALLOWED_USERS=ou_xxxx,ou_yyyy

# Admin chat ID for pipeline-level notifications (task failed, pipeline complete, stuck agents)
# Get this from the Feishu open platform or from the bot's chat info
# FEISHU_ADMIN_CHAT_ID=oc_xxxxxxxxxxxx