docs(selfhost): make beta onboarding image-first#2650
Conversation
The documented self-host path was source-build-first (docker compose up --build) even though a published-image deploy script (scripts/deploy-selfhost-image.sh) already existed and was never surfaced in the docs. The sample env also mixed Cloudflare Worker vars with self-host-only vars, with no focused starter file, no AI-provider quick-pick, and no enabled/opt-in defaults table. - Quickstart now leads with ./scripts/deploy-selfhost-image.sh (pull the published image, no local build/Node toolchain) as the recommended boot path, with `docker compose up --build` demoted to an explicit "building from source" alternative for contributors. - New .env.selfhost.example: the short path -- required secrets plus the existing conservative first-boot config, with nothing about the Worker deploy. .env.example remains the exhaustive reference for every optional service. - New "Choose your AI provider" step with copy-paste Claude-Code-only / Codex-only / both blocks, plus the existing Codex fail-closed safety callout surfaced up front instead of only in the env file comments. - New "Defaults at a glance" table: what's on by default vs. what needs an explicit --profile or AI_PROVIDER, plus the Orb telemetry always-on notice. - Quickstart's log-events step now explains which first-boot log noise is expected (migrations burst, brief Redis retry) vs. worth investigating. - docker-compose.yml's header comment documents both boot paths instead of only the build-from-source one.
|
Warning 🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨 ⏸️ Gittensory review result - manual review recommendedReview updated: 2026-07-03 00:41:39 UTC
⏸️ Suggested Action - Manual Review
Review summary Nits — 7 non-blocking
Concerns raised — review before merging
Review context
Contributor next steps
Signal definitions
🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed 💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →. Checked by Gittensory, a quiet PR intelligence layer for OSS maintainers.
|
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
gittensory-ui | 273f8bb | Commit Preview URL Branch Preview URL |
Jul 03 2026, 12:27 AM |
…ate review nits The AI-provider quickstart snippet showed all three mutually exclusive AI_PROVIDER assignments as one uncommented .env block, so copying it wholesale set AI_PROVIDER three times and landed on the combined-provider mode instead of the one actually chosen. - Split into three separately copyable CodeBlocks, one per provider choice. - Move "Defaults at a glance" after the numbered steps instead of between 3 and 4, so the sequential flow isn't interrupted by a reference table. - Fix "everything else on this page" wording in a compose-file comment and a quickstart callout (a compose file isn't a page). - Mirror the Orb telemetry wording between .env.selfhost.example and the Quickstart callout, and clarify it's an always-on contract with one explicit disable path (ORB_AIR_GAP), not a flag with a listed opt-out.
Closes #1938
Summary
docker compose up --build) even though a published-image deploy script (scripts/deploy-selfhost-image.sh) already existed and was never surfaced in the docs. The sample env also mixed Cloudflare Worker vars with self-host-only vars, with no focused starter file, no AI-provider quick-pick, and no enabled/opt-in defaults table../scripts/deploy-selfhost-image.sh(pull the published image, no local build/Node toolchain) as the recommended boot path, withdocker compose up --builddemoted to an explicit "building from source" alternative for contributors..env.selfhost.example: the short path — required secrets plus the existing conservative first-boot config, with nothing about the Worker deploy..env.exampleremains the exhaustive reference for every optional service.AI_PROVIDERthree times), plus the existing Codex fail-closed safety callout surfaced up front instead of only in the env file comments.--profileorAI_PROVIDER, plus the Orb telemetry always-on notice.docker-compose.yml's header comment documents both boot paths instead of only the build-from-source one.No dedicated tests
Docs/config content changes (compose header comment, docs page copy, a new sample env file) — no
src/**logic changed, not measured by Codecov. Verified manually:docker compose config -q(compose still valid), a running dev server render of the new Quickstart flow, and the full local gate.Test plan
npm run ui:typecheck,npm run ui:lint— cleannpm run test:ci(full local gate, unsharded) — greennpm audit --audit-level=moderate— 0 vulnerabilitiesdocker compose config -q— compose file still valid after the header comment update