CodePlans/.env.example at master · SylonZero/CodePlans · 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
72
73
# ─────────────────────────────────────────────
# CodePlans — Environment Configuration
# Copy this file to .env.local and fill in the
# values for your chosen setup.
# ─────────────────────────────────────────────


# ── Host mode ─────────────────────────────────
# saas: multi-tenant hosted instance, open registration, billing available.
# team: single private team, registration closed by default, billing hidden.
HOST_MODE=team

# ── Registration ──────────────────────────────
# open:   anyone can sign up at /signup.
# invite: /signup shows an invite-only message (token flow coming soon).
# closed: /signup returns 404; users created by admin via pnpm db:seed.
REGISTRATION=closed

# ── Auth & DB providers ───────────────────────
# auth:  "local" (bcrypt + session cookie) or "supabase"
# db:    "sqlite" (local file / in-memory) or "postgres"
AUTH_PROVIDER=local
DB_PROVIDER=sqlite


# ── Database ──────────────────────────────────
# SQLite: must use file: prefix for a local path, or ":memory:" for ephemeral
# Postgres: full connection string (used when DB_PROVIDER=postgres)
DATABASE_URL=file:data/codeplans.db
# DATABASE_URL=postgresql://user:password@localhost:5432/codeplans
# DB_SSL=false  # set to false for local Postgres; defaults to true for hosted providers


# ── Local auth ────────────────────────────────
# Required when AUTH_PROVIDER=local.
# Must be at least 32 characters. Generate one with:
#   openssl rand -base64 32
AUTH_SECRET=change-me-to-a-random-string-at-least-32-chars

# Required in production (Auth.js uses this to construct callback URLs and
# validate login redirects). Set to the full URL your server is reachable at.
# Not needed for local dev on localhost.
# AUTH_URL=https://codeplans.yourteam.com
# AUTH_URL=http://YOUR_SERVER_IP:3000


# ── Server ───────────────────────────────────
# Port for the dev server (default: 3000)
PORT=3000

# ── Remote dev server (optional) ─────────────
# When running `pnpm dev` on a remote host and accessing it from a browser
# on a different IP, add the server's IP or hostname here (comma-separated).
# ALLOWED_DEV_ORIGINS=165.22.120.48

# ── Feature flags ─────────────────────────────
# Set to "false" to hide all billing UI (default for OSS / local mode).
BILLING_ENABLED=false


# ── Resend (transactional email) ──────────────
# Required for email verification (email change, future: team invites).
# Get an API key at https://resend.com → API Keys.
# Without this, verification URLs are printed to the server console (dev only).
# RESEND_API_KEY=re_xxxxxxxxxxxxxxxxxxxx
# RESEND_FROM_EMAIL=CodePlans <noreply@yourdomain.com>


# ── Supabase (cloud mode only) ────────────────
# Required when AUTH_PROVIDER=supabase or DB_PROVIDER=postgres via Supabase.
# NEXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co
# NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY=your-anon-key
# SUPABASE_SECRET_KEY=your-service-role-key