docs: restructure self-hosting into modular sub-pages with architectu…#615
Open
Tanmaycode1 wants to merge 2 commits intodevfrom
Open
docs: restructure self-hosting into modular sub-pages with architectu…#615Tanmaycode1 wants to merge 2 commits intodevfrom
Tanmaycode1 wants to merge 2 commits intodevfrom
Conversation
- Add ## About as first H2 to all 8 self-hosting pages. Other doc categories (dataset, evaluation, observe, error-feed) have 100% compliance with this convention; this brings self-hosting in line. - Add ## Next Steps card group to the 7 sub-pages that were missing it. - Rename ## Guides → ## Next Steps on the hub page for consistency. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
khushalsonawat
requested changes
Apr 29, 2026
Contributor
khushalsonawat
left a comment
khushalsonawat
left a comment
There was a problem hiding this comment.
Check the comments and revisit the doc once
| title: 'Self-Hosting', | ||
| badge: 'New', | ||
| items: [ | ||
| { title: 'Overview', href: '/docs/self-hosting' }, |
Contributor
There was a problem hiding this comment.
Where will this point to? There is no such file as self-hosting. Test the navigation once
|
|
||
| ## About | ||
|
|
||
| Configure the moving parts that aren't covered by `.env` alone: provider entries in the LLM gateway's `config.yaml`, the PeerDB Postgres → ClickHouse replication mirrors, and Temporal worker concurrency. |
Contributor
There was a problem hiding this comment.
Change this line. Complete the configuration or something. Also, this must be mentioned in the appropriate place where it is visible to public that gateway needs additional configuration
|
|
||
| First boot builds from source (~10–15 min). When the backend logs `Application startup complete`: | ||
|
|
||
| - **Frontend** — [http://localhost:3031](http://localhost:3031) |
Contributor
There was a problem hiding this comment.
incorrect link: https://localhost:3000 if raised using docker compose.
| docker compose logs -f backend | ||
| ``` | ||
|
|
||
| Starts all 21 services. Frontend binds on `0.0.0.0:3031`; all data stores bind on `127.0.0.1`. For production, put a reverse proxy (Caddy, nginx, Traefik) in front for HTTPS. |
Contributor
There was a problem hiding this comment.
Port for frontend is 3000 via docker compose. If they run separately, it's via port 3031
| | Per-queue workers | 6 workers (`worker-default`, `worker-tasks-s`, `worker-tasks-l`, `worker-tasks-xl`, `worker-trace-ingestion`, `worker-agent-compass`) instead of one all-queue worker | | ||
| | Public DB ports | Postgres, ClickHouse, Redis, MinIO, Temporal all bind on `0.0.0.0` for host tool access | | ||
| | Temporal UI | [http://localhost:8085](http://localhost:8085) | | ||
| | `FAST_STARTUP=true` | Migrations skipped on restart — run manually: `docker compose exec backend python manage.py migrate` | |
Contributor
There was a problem hiding this comment.
The command that I use is: docker compose exec -it backend bash python manage.py migrate. Just verify if the said command works
|
|
||
| All configurable. See [Requirements → Ports reference](/docs/self-hosting/requirements#ports-reference) for the full table with defaults and exposure scope. | ||
|
|
||
| To run two stacks side-by-side: `docker compose --env-file .env.stackb -p stackb up -d` |
Contributor
There was a problem hiding this comment.
I have no clue about this command.
|
|
||
| | Service | Default | Exposed to | `.env` key | | ||
| |---|---|---|---| | ||
| | Frontend | `3031` | `0.0.0.0` | `FRONTEND_PORT` | |
| docker compose restart backend | ||
| ``` | ||
|
|
||
| Then sign up via [http://localhost:3031](http://localhost:3031). |
| " | ||
| ``` | ||
|
|
||
| Log in at [http://localhost:3031](http://localhost:3031) with those credentials. |
| ``` | ||
| | Service | URL | | ||
| |---|---| | ||
| | Frontend | http://localhost:3031 | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Restructures the self-hosting documentation from a single monolithic page into a modular, navigable section.
Changes:
self-hosting.mdxas a concise overview page with an architecture diagram, data flow, and quick start commandsrequirements,docker-compose,environment,configuration,user-management,production,troubleshootingnavigation.tsto expose all sub-pages in the sidebar under a collapsible Self-Hosting group with an explicit Overview entrydocker-compose.yml,.env.example,INSTALLATION.md, anddocker-compose.dev.ymlin the monorepoNew structure: