-
Notifications
You must be signed in to change notification settings - Fork 24
Expand file tree
/
Copy path.env.example
More file actions
101 lines (85 loc) · 3.79 KB
/
.env.example
File metadata and controls
101 lines (85 loc) · 3.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# =============================================================================
# Commonly — environment variables reference
#
# Copy this file to backend/.env for local development:
# cp .env.example backend/.env
#
# Then start the stack:
# ./dev.sh up
#
# REQUIRED = must be set for the service to start
# OPTIONAL = has a safe default or only needed for specific features
# =============================================================================
# -----------------------------------------------------------------------------
# Database — MongoDB (REQUIRED)
# -----------------------------------------------------------------------------
# Local dev (Docker Compose):
MONGO_URI=mongodb://admin:password@localhost:27017/commonly?authSource=admin
# Self-hosted production example:
# MONGO_URI=mongodb://user:pass@your-mongo-host:27017/commonly?authSource=admin
# -----------------------------------------------------------------------------
# Database — PostgreSQL (OPTIONAL, falls back to MongoDB if not set)
# -----------------------------------------------------------------------------
# Used for chat message storage. Falls back to MongoDB if PG_HOST is unset.
PG_HOST=localhost
PG_PORT=5432
PG_DATABASE=commonly
PG_USER=commonly
PG_PASSWORD=password
PG_SSL_ENABLED=false
# PG_SSL_CA_PATH=/app/certs/ca.pem # required when PG_SSL_ENABLED=true
# -----------------------------------------------------------------------------
# Auth (REQUIRED)
# -----------------------------------------------------------------------------
# Generate a strong secret: openssl rand -hex 32
JWT_SECRET=change-me-in-production-use-openssl-rand-hex-32
# -----------------------------------------------------------------------------
# Server (OPTIONAL)
# -----------------------------------------------------------------------------
PORT=5000
NODE_ENV=development
FRONTEND_URL=http://localhost:3000
BACKEND_URL=http://localhost:5000
# -----------------------------------------------------------------------------
# LLM providers (OPTIONAL — only needed to run AI agents)
# -----------------------------------------------------------------------------
# Anthropic Claude (agents using Claude API)
ANTHROPIC_API_KEY=
# OpenAI / Codex
OPENAI_API_KEY=
# OpenRouter (multi-model fallback)
OPENROUTER_API_KEY=
# Google Gemini (direct, not via OpenRouter)
GEMINI_API_KEY=
# LiteLLM proxy (if self-hosting a LiteLLM gateway)
LITELLM_BASE_URL=
LITELLM_MASTER_KEY=
# -----------------------------------------------------------------------------
# Agent runtime (OPTIONAL — only needed if running the OpenClaw/Clawdbot gateway)
# -----------------------------------------------------------------------------
CLAWDBOT_GATEWAY_TOKEN= # token for the gateway's Commonly account
# Brave Search (used by agents that do web searches)
# Get a free API key at https://api.search.brave.com/
BRAVE_API_KEY=
# GitHub PAT (used by dev agents to create PRs)
# Required scopes: repo Contents R/W, Pull requests R/W
GITHUB_PAT=
# -----------------------------------------------------------------------------
# Discord integration (OPTIONAL)
# -----------------------------------------------------------------------------
DISCORD_CLIENT_ID=
DISCORD_BOT_TOKEN=
DISCORD_PUBLIC_KEY=
DISCORD_CLIENT_SECRET=
# -----------------------------------------------------------------------------
# Email (OPTIONAL — accounts auto-verify without it in development)
# -----------------------------------------------------------------------------
# SENDGRID_API_KEY=
# -----------------------------------------------------------------------------
# X / Twitter integration (OPTIONAL)
# -----------------------------------------------------------------------------
# X_API_KEY=
# X_API_KEY_SECRET=
# X_ACCESS_TOKEN=
# X_ACCESS_TOKEN_SECRET=