docs: add self-hosting system configuration page#695
docs: add self-hosting system configuration page#695abhijaisrivastava15 wants to merge 5 commits into
Conversation
- Lean what/when/architecture overview that routes setup detail to the Configure subfolder - Keep the architecture diagram and the deployment-options table
- title: sentence case to match sidebar label - description: remove em-dash, shorten to single purpose line TH-6329
| - **CDC**: PeerDB (continuous Postgres → ClickHouse replication) | ||
|
|
||
| **Workflow** — `temporal` | ||
| Everything runs on your machines; nothing leaves your network. The full service-by-service breakdown lives in [Configure](/docs/self-hosting/configure) |
There was a problem hiding this comment.
Typo, should be /configuration. The Configure card below has it too
| <Card title="User Management" icon="user" href="/docs/self-hosting/user-management"> | ||
| Create accounts via email or Django shell. | ||
| <CardGroup cols={3}> | ||
| <Card title="Configure" icon="gear" href="/docs/self-hosting/configure"> |
There was a problem hiding this comment.
Same typo, /configure → /configuration
| </Card> | ||
| <Card title="Troubleshooting" icon="wrench" href="/docs/self-hosting/troubleshooting"> | ||
| Solutions for every known error. | ||
| <Card title="Support" icon="comments" href="/docs/self-hosting/support"> |
There was a problem hiding this comment.
No coming soon. Implement the new self-hosting sidebar and Support (plus the other missing pages) come with it:
Overview
Requirements
Install
Configuration
Environment variables
System configuration
Production
Checklist
Security & TLS
Backups & restore
Monitoring
Upgrades & rollback
Troubleshooting & FAQs
Support
| description: "Configure the LLM gateway, PeerDB replication, and Temporal workers for your self-hosted instance." | ||
| --- | ||
|
|
||
| ## Introduction |
There was a problem hiding this comment.
Introduction is a bit bland, rename it. Maybe In this page
|
|
||
| ## Introduction | ||
|
|
||
| A few parts of the stack are configured outside `.env`: the LLM gateway needs a `config.yaml` listing its providers, PeerDB needs its replication mirrors running, and Temporal workers can be tuned for throughput. This page covers all three. Set your secrets and provider keys in [Environment Variables](/docs/self-hosting/configuration/environment) first — the config here references them. |
There was a problem hiding this comment.
Drop the em-dash. The env link is right for the new sidebar (env moves under Configuration), just move the page there
| <Steps> | ||
| <Step title="Copy the Example Config"> | ||
| ```bash | ||
| cp futureagi/agentcc-gateway/config.example.yaml \ |
There was a problem hiding this comment.
Path's off, agentcc-gateway sits at the repo root, not under futureagi/. Same on the mount below. Commands won't run as is
|
|
||
| **All-queue (default).** One worker polls every task queue. Controlled by `TEMPORAL_ALL_QUEUES=true` in `.env`. This is the right setup for most self-hosted deployments. | ||
|
|
||
| **Per-queue (dev overlay).** Six dedicated workers, one per queue, brought up by the [dev overlay](/docs/self-hosting/install#dev-overlay): |
There was a problem hiding this comment.
Install comes with the new sidebar, add it there
| ## Dive Deeper | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="Production Checklist" icon="shield" href="/docs/self-hosting/production/checklist"> |
There was a problem hiding this comment.
Checklist is part of the new Production group, add it with the sidebar
- Fix /configure -> /configuration link typo on the overview (prose + card) - Rename System configuration opener from Introduction to In this page - Drop em-dashes across the page (intro + gateway/PeerDB sections) - Fix gateway config path: agentcc-gateway is at repo root, not under futureagi/
What
Adds the System Configuration reference page for self-hosted FutureAGI.
Pages added
src/pages/docs/self-hosting/configuration/system.mdx— LLM gateway config.yaml setup (with Steps + Tabs for OpenAI/Bedrock/Vertex), PeerDB replication first-boot fix, Temporal Workers concurrency tablePreview
Then visit: http://localhost:4444/docs/self-hosting/configuration/system
TH-6328