Skip to content

Update .env.example #377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kitenite merged 1 commit into from
Dec 15, 2025
Merged

Update .env.example #377

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 44 additions & 24 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,49 @@
# Database
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/superset
DATABASE_URL_UNPOOLED=postgresql://postgres:postgres@localhost:5432/superset

# Neon (for database branching)
NEON_API_KEY=your_neon_api_key_here
NEON_ORG_ID=your_neon_org_id_here
NEON_PROJECT_ID=your_neon_project_id_here
NEON_BRANCH_ID=your_neon_branch_id_here

# Clerk Authentication
CLERK_SECRET_KEY=your_clerk_secret_key_here
CLERK_WEBHOOK_SECRET=your_clerk_webhook_secret_here
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key_here

# App URLs
NEXT_PUBLIC_WEB_URL=http://localhost:3000


# =============================================================================
# ROOT SUPERSET ENV
# Shared by all worktrees via direnv
# =============================================================================

Comment on lines +3 to +7
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Header still mentions direnv, likely stale after moving to dotenv

Comment says “Shared by all worktrees via direnv”, but PR history indicates env loading was refactored to dotenv. Suggest updating this wording (or making it tool-agnostic) to avoid confusing new contributors. You may also want to drop the extra blank line at the very top to satisfy dotenv‑linter’s ExtraBlankLine warning.

🤖 Prompt for AI Agents 
In .env.example around lines 3 to 7, the header still references "direnv" and
there is an extra blank line at the top; update the header text to remove or
make tool-agnostic (e.g., "Shared by all worktrees" or "Loaded by dotenv") and
remove the leading blank line so the file starts with the header immediately to
satisfy dotenv-linter's ExtraBlankLine rule.

# -----------------------------------------------------------------------------
# Neon Organization Credentials
# -----------------------------------------------------------------------------
NEON_ORG_ID=
NEON_PROJECT_ID=
NEON_API_KEY=

# -----------------------------------------------------------------------------
# Neon Database Credentials (Production)
# -----------------------------------------------------------------------------
DATABASE_URL=
DATABASE_URL_UNPOOLED=

# -----------------------------------------------------------------------------
# Cross-App URLs (Local Dev)
# -----------------------------------------------------------------------------
NEXT_PUBLIC_API_URL=http://localhost:3001
NEXT_PUBLIC_ADMIN_URL=http://localhost:3002
NEXT_PUBLIC_MARKETING_URL=http://localhost:3003
NEXT_PUBLIC_WEB_URL=http://localhost:3000
NEXT_PUBLIC_ADMIN_URL=http://localhost:3003
NEXT_PUBLIC_MARKETING_URL=http://localhost:3002
NEXT_PUBLIC_DOCS_URL=http://localhost:3004

# -----------------------------------------------------------------------------
# Clerk Auth
# -----------------------------------------------------------------------------
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=
CLERK_WEBHOOK_SECRET=
NEXT_PUBLIC_COOKIE_DOMAIN=localhost

# Vercel Blob Storage
BLOB_READ_WRITE_TOKEN=your_blob_token_here
# -----------------------------------------------------------------------------
# Blob Storage
# -----------------------------------------------------------------------------
BLOB_READ_WRITE_TOKEN=

# Desktop App
VITE_DEV_SERVER_PORT=4927
DESKTOP_AUTH_SECRET=your_desktop_auth_secret_here_min_32_chars
# -----------------------------------------------------------------------------
# PostHog Analytics (Local Dev)
# -----------------------------------------------------------------------------
NEXT_PUBLIC_POSTHOG_KEY=
POSTHOG_API_KEY=
POSTHOG_PROJECT_ID=
DESKTOP_AUTH_SECRET=