Skip to content

docs(self-hosting): run the setup doctor from the Docker image #155

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
charlesrhoward merged 1 commit into from
Oct 16, 2026
Merged

docs(self-hosting): run the setup doctor from the Docker image #155

Show file tree
Hide file tree
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
9 changes: 7 additions & 2 deletions content/docs/self-hosting/operations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ import { Callout } from 'fumadocs-ui/components/callout';
```bash
pnpm setup:doctor # configuration checks
pnpm setup:doctor --live # also tests Trigger.dev and Vercel credentials

# Docker: the image ships the same doctor
docker compose exec app node scripts/doctor.cjs [--live]
```

The doctor checks the database (connection, pending migrations, runtime role),
Expand All @@ -20,7 +23,8 @@ it as a deploy gate.

For uptime monitoring, `GET /api/health` returns `200` when the database is
reachable and `503` when it is not. The response lists which services are
configured and contains no secrets.
configured and contains no secrets. `models` counts as configured with an AI
Gateway key or an OpenAI-compatible endpoint that lists at least one model.

## Upgrades

Expand All @@ -35,7 +39,8 @@ list breaking changes to env vars and migrations. For each upgrade:
`migrate` service applies them before the new app starts.
4. Deploy the app.
5. Deploy the Trigger.dev tasks from the same commit: `pnpm trigger:deploy`.
6. Run `pnpm setup:doctor`.
6. Run `pnpm setup:doctor`, or `docker compose exec app node scripts/doctor.cjs`
with Docker.

Migrations stay compatible with the previous app release, so apply them
**before** you deploy the new code. Production uses the same order.
Expand Down
3 changes: 3 additions & 0 deletions content/docs/self-hosting/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,9 @@ Add these in order. Each one is independent.

```bash
pnpm setup:doctor # add --live to test credentials against the services

# Docker: run it inside the image, no checkout needed
docker compose exec app node scripts/doctor.cjs
```

The doctor reports each service as pass, warn, or fail, and links the page that
Expand Down
Loading