docs: clarify Clerk is required (remove optional wording)

This commit is contained in:
Abhimanyu Saharan
2026-02-11 10:08:36 +00:00
parent 89ad25b624
commit 93f52f9273
7 changed files with 39 additions and 27 deletions

View File

@@ -32,10 +32,13 @@ Operational deep dives:
## Authentication (Clerk)
Clerk is **optional for local/self-host**.
**Clerk is currently required**.
- The frontend enables Clerk only when `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` is set.
- If youre not configuring Clerk locally, keep Clerk env vars **unset/blank**.
You must configure Clerk keys for:
- the frontend (`NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY`, `CLERK_SECRET_KEY`)
- the backend (`CLERK_SECRET_KEY`)
See: [`docs/deployment/README.md`](./docs/deployment/README.md#clerk-auth-notes).
## Deployment modes
@@ -50,6 +53,9 @@ cp .env.example .env
# NEXT_PUBLIC_API_URL must be reachable from the *browser* (host), not an internal Docker network name.
# Missing/blank NEXT_PUBLIC_API_URL will break frontend API calls (e.g. Activity feed).
# REQUIRED: Clerk config.
# Provide real Clerk values via frontend/.env (recommended) and backend/.env.
docker compose -f compose.yml --env-file .env up -d --build
```