commitpulse/.env.local.example at main · KTQ0912/commitpulse · GitHub

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
# Copy this file to .env.local and fill in your actual values.
# NEVER commit your .env.local file to version control.

# The absolute URL of your deployment (e.g., http://localhost:3000)
# Required for generating full URLs like OG images and API redirects.
NEXT_PUBLIC_SITE_URL=http://localhost:3000

# MongoDB Connection URI for storing sessions and analytics.
# Get yours from MongoDB Atlas (e.g., mongodb+srv://<user>:<pass>@cluster...)
MONGODB_URI=mongodb+srv://<username>:<password>@cluster0.mongodb.net/commitpulse?retryWrites=true&w=majority

# GitHub Personal Access Token(s) to avoid strict public GraphQL limits.
# Generate at: https://github.com/settings/tokens (No scopes required)
# For multi-token pool rotation (multiplies your API quota), use GITHUB_TOKENS:
#   GITHUB_TOKENS=ghp_token1,ghp_token2,ghp_token3
# Falls back to GITHUB_PAT, then GITHUB_TOKEN for backward compatibility.
GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# GitHub OAuth App (https://github.com/settings/developers)
# Callback URL: http://localhost:3000/api/auth/callback/github
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=

# Generate with: openssl rand -base64 32
AUTH_SECRET=

# Required for encrypting stored third-party API tokens.
# Use a unique random secret with at least 32 characters.
ENCRYPTION_KEY=

# Vercel KV / Upstash Redis URL for distributed rate limiting.
# Leave blank to operate with degraded local-memory rate limits.
KV_REST_API_URL=

# Vercel KV / Upstash Redis API token for authentication.
# Leave blank to operate with degraded local-memory rate limits.
KV_REST_API_TOKEN=

# Maximum background dashboard force-refreshes allowed per user per hour.
# Defaults to 5 if left blank.
MAX_REFRESHES_PER_HOUR=5

# Comma-separated list of trusted proxy IPs (e.g., Cloudflare, Nginx).
# Required to correctly identify client IPs behind reverse proxies.
TRUSTED_PROXIES=

# Set to "true" to automatically trust private IPs (10.x, 192.168.x).
# Defaults to "false" (automatically enabled in development).
TRUST_PRIVATE_PROXIES=false

# Comma-separated list of allowed dev origins for local development.
# Set this to your local machine's IP if you face CORS errors during dev.
# Example: NEXT_ALLOWED_DEV_ORIGINS=192.168.1.100,172.31.128.1
NEXT_ALLOWED_DEV_ORIGINS=

# Comma-separated list of GitHub user IDs allowed to access enterprise API routes.
# Find your GitHub user ID at https://api.github.com/users/<username> (the "id" field).
# Example: ENTERPRISE_ADMIN_GITHUB_IDS=12345678,87654321
ENTERPRISE_ADMIN_GITHUB_IDS=

# Spotify Integration (Optional)
# Required for the "Currently Playing" SVG feature.
# Follow the setup guide in the documentation to get these credentials.
SPOTIFY_CLIENT_ID=
SPOTIFY_CLIENT_SECRET=
SPOTIFY_REFRESH_TOKEN=

# WakaTime Integration (Optional)
# Required for the WakaTime stats SVG feature.
# Follow the setup guide in docs/WAKATIME_SETUP.md to get your API key.
WAKATIME_API_KEY=