docs(self-hosting): Standalone default, Distributed, Helm chart, telemetry (ships with the next release) - #877
Merged
Merged
Conversation
…rview; nav and redirects Standalone (3 containers) becomes the default setup; the overview compares the three setups, says what each runs and what leaves the network, and warns that Standalone data cannot move to Distributed or Helm. The orphan docker-compose and configuration pages are removed with redirects, and the nav gains Helm (Kubernetes), Telemetry and Users & sign-in. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Sizing per setup (Standalone 2 vCPUs / 4 GB, Distributed 12-16 GB), ./bin/install and its flags, verifying the stack, everyday operations, switching setups, and ./bin/dev for contributors. The Compose cookbook follows the Standalone default. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
New page for oci://ghcr.io/future-agi/charts/futureagi: supported configurations, verifying the signature and attestation, evaluation and production installs, the first account, upgrades, backups, troubleshooting and the support bundle. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
… page The environment page keeps the commonly set variables and links the repository's full reference; the new telemetry page says exactly what is sent, how to turn it off, and every other outbound connection. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Profiles per setup (ml and sandbox on Standalone), the /setup first-run screen, and account creation, recovery and sign-in lockout. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…rades per setup Includes upgrading installs made with v1.41.x or earlier, which stay on Distributed, and drops advice to set FRONTEND_PORT to an address, which the installer does not support. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…key sync A self-hosted install already runs the gateway. Local model servers on a private address need AGENTCC_ALLOW_PRIVATE_PROVIDER_URLS=true; keys re-sync every 60 seconds on a self-hosted install; buffered request logs are delivered on shutdown. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
v1.42.0 shipped with the old layout too, so "v1.41.x or earlier" was already stale. Older installs are now "installs made before Standalone became the default", defined once, with how to tell, on the upgrades page. Each rewritten claim was checked against v1.41.3 and v1.42.0. The sequencer volume and attribute-suggestion notes now match the releases that actually had them. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…rm repo Add /docs/self-hosting/configuration/reference: every environment variable of a self-hosted install with its default in each setup, the setups that read it and what breaks when it is wrong. The page is rendered by scripts/docs_site.py from deploy/env-reference.toml in future-agi/future-agi, which replaces the repository's docs/configuration.md; edit the data file, not this page. Point the Environment variables and Helm pages at it instead of the GitHub copy of docs/configuration.md. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Add /docs/self-hosting/images (every image with what it runs, ports, user, health check, architectures and size budget; backend variants, tags, labels, verifying an image, health checks, users, stopping, base images, build arguments, building them yourself) and /docs/self-hosting/development (./bin/dev: what reloads, commands, migrations, databases, tests, --distributed, troubleshooting), moved from the repository's docs/images.md and docs/development.md. The Images at a glance and Labels tables sit between generated markers that scripts/docs_site.py in future-agi/future-agi fills from deploy/images.toml and scripts/image_size_budget.json. Link the new pages from the nav, the overview, Installation, Requirements and Upgrades & rollback. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
… the telemetry page Merge the repository's docs/telemetry.md into the telemetry page: an At a glance table of every outbound connection, the registration and heartbeat payloads with each field, how it is sent (endpoints, size cap, signature header, private buffer), a Settings table, the third-party services in detail with AWS and GCP Marketplace, and The browser UI with each host it loads, what an air-gapped install loses without it and the build-time analytics keys. The payload and settings tables sit between generated markers that scripts/docs_site.py in future-agi/future-agi fills from wire_reference.toml and deploy/env-reference.toml. No link to docs/telemetry.md remains. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…form repo data Run `python3 scripts/docs_site.py sync` from future-agi/future-agi over the generated blocks: the registration and heartbeat payloads from wire_reference.toml, the telemetry settings from deploy/env-reference.toml, and Images at a glance and Labels from deploy/images.toml and scripts/image_size_budget.json. Drop the hand-written sentences the blocks now carry themselves. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…elease files Re-run `python3 scripts/docs_site.py sync` from future-agi/future-agi's feat/helm-publish over the configuration reference: the Helm values behind the first admin, license, SSO clients, read replica, direct Postgres, gateway Redis, APP_VERSION, SIM_COLLECTOR_OTLP_ENDPOINT, allowed hosts and CORS, and a new "Proxy, CA bundle and air-gap" section. By hand, from the Helm branch's docs/images.md and docs/telemetry.md: the Helm page's Verify the chart names the release files (package, checksums, images list, Hauler manifest) and image.digests; the images page's signature step points at it; the telemetry page says global.airgap's opt-out registration fails harmlessly and is retried. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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
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.
Summary
Rewrites the Self-Hosting section for the self-hosting overhaul in future-agi/future-agi. After that release, the default
./bin/installgives Standalone: 3 containers, 2 vCPUs and 4 GB of Docker memory. Distributed (./bin/install --distributed) is the former multi-container stack, and Helm is a signed OCI chart for Kubernetes.Merge this at release time, not before. Until then, these pages would tell v1.41.x users to run commands and use images they don't have yet.
Code PRs this documents, all open:
./bin/dev.oci://ghcr.io/future-agi/charts/futureagi, signed.AGENTCC_ALLOW_PRIVATE_PROVIDER_URLS, key sync.What changed
/docs/self-hosting):docs/development.mdfor./bin/dev./docs/self-hosting/helm):/docs/self-hosting/configuration/telemetry):/docs/self-hosting/configuration/reference): every environment variable, per setup (Standalone, Distributed, Helm). It replaces thedocs/configuration.mdthat feat(deploy): light Standalone install by default, Distributed at scale, Helm chart and hot-reload dev future-agi#3097 no longer ships. The page is generated:python3 scripts/docs_site.py sync <this checkout>, run in the code repo, renders it fromdeploy/env-reference.toml, whose completeness that repo's CI checks. Do not edit it by hand./docs/self-hosting/images): published images, tags, variants, architectures and how to verify an image. Its tables are generated fromdeploy/images.tomland the size budgets./docs/self-hosting/development):./bin/devfor contributors. It replaces the repo'sdocs/development.md.docs/telemetry.md: the payload fields, examples, settings and browser hosts. Its tables are generated fromwire_reference.toml./launch-mode) are updated.FRONTEND_PORT=127.0.0.1:3000is removed, because the installer takes a port number only and that value breaks it.AGENTCC_ALLOW_PRIVATE_PROVIDER_URLS=true;self-hosting/docker-composeandself-hosting/configuration, with redirects.Links into the code repo use
blob/main, which matches the released version once this merges.How it was checked
futureagi/platform;docker compose config.npm run build: 1178 pages built, including the two new pages and the redirect pages;npm run audit-links: 0 broken nav links, 0 broken content links.npm cifails ondevtoo, becausepackage-lock.jsonis out of sync withpackage.json. That is unrelated to this PR; I built withnpm install --no-save.Before merging
python3 scripts/docs_site.py sync <this checkout> --ref vX.Y.Z --check. The generated reference, telemetry and images blocks must match that release's data. Without--checkit rewrites them.helm pull oci://ghcr.io/future-agi/charts/futureagi --version X.Y.Zworks without signing in, which means the GHCR package is public.futureagi/standalone:vX.Y.Zis on Docker Hub.installation.mdxand the Docker VM sizing tip inrequirements.mdx. Keep this branch's text and add the Colima link.colima.mdxupdated for the new stack. It still describes a 13-service stack with 8 GiB of memory, an amd64-only backend image, and development mode throughdocker-compose.dev.ymlandDOCKER_SOCKET(now./bin/dev). After that, link it from troubleshooting's "Docker cannot see the checkout" entry.Follow-ups (not in this PR)
Several cookbook pages say to point
FI_BASE_URLat "your self-hosted deployment" without saying which address:cookbook/quickstart/instrument-and-verify*.mdx;cookbook/trustworthy-rag.mdx;simulation/guides/run-chat-simulation.mdx.Tracing uses the collector on port 4318, and the API is on port 8000.
command-center/concepts/configuration.mdxsays self-hosted deployments watch the config file. The gateway re-reads it onPOST /-/reloadinstead. This predates the overhaul.AI use: Claude Code (Claude Opus 5.5) wrote the pages and checked them against the code, with separate accuracy and style reviewers per page. A maintainer needs to review it.
🤖 Generated with Claude Code