Skip to content

feat(docs): Improve .env.example clarity and setup guidance for self-hosting beginners #588

@sebastien-lenard

Description

@sebastien-lenard

Is your feature request related to a problem? Please describe.
The current apps/web/.env.example file, while functional, can be challenging for new contributors to understand fully. It lacks explicit guidance on which variables are mandatory, where to obtain values (e.g., Supabase, Upstash, Google Cloud Console), and notes on common setup pitfalls.

Describe the solution you'd like
I've updated the apps/web/.env.example file to include:

  • Clear sections for different configurations (Database, Auth, LLM, etc.).
  • Labels for MANDATORY vs. OPTIONAL variables.
  • Concise comments explaining the purpose of each variable.
  • Hints on where to obtain API keys/credentials (e.g., "Get from Upstash.com").
  • Specific notes on common setup issues (e.g., AUTH_TRUST_HOST, NEXT_PUBLIC_POSTHOG_ONBOARDING_SURVEY_ID redirect loop).

This aims to significantly improve the onboarding experience for new developers.

Describe alternatives you've considered
N/A - This is a direct improvement to existing documentation.

Additional context
I've already implemented these changes locally and verified the app runs with the new .env.example structure. I'm ready to open a Pull Request once this approach is confirmed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions