Operator IPFS onboarding: run your own Kubo as preferred content source #14

Merged
rhelwig merged 2 commits from rhelwig/operator-ipfs-onboarding into main 2026-10-10 20:46:28 +00:00 AGit
Owner

Makes running your own Kubo (like the ronhelwig.com VPS node) the obvious default for every DecentSite operator, and makes it easy to publish it as the site's preferred content source.

Admin

  • New apps/admin/src/operator-onboarding.ts checklist (no network calls).
  • Sites page: "Set up publishing storage" card while canonical storage is local test storage or Kubo is unreachable. Hidden once Kubo is ready.
  • Site page: "Your own IPFS source" card until Kubo is connected, the site lists an HTTPS gateway, and it has a preferred content source. A second independent source is shown as optional, never required.
  • Links to the DEPLOY/INSTALL guides from the checklist, Site settings → Preferred content sources, and Prepare review (when no sources are set). DECENT_SITE_DOCS_URL overrides the docs base for forks.

Docs

  • docs/DEPLOY.md: new section "Your own IPFS node and preferred content source": install Kubo, Gateway.NoFetch, a read-only nginx/Caddy gateway (GET /ipfs/ only, never RPC 5001), port 4001, adding the gateway and multiaddr as preferred sources, checking pins after publish, an optional second Kubo node or Pinning Service API provider (token stays on the Kubo machine), and why public gateways (rate limits, notice pages) are a fallback only. The durable path is the owner's gateway plus the hash check.
  • docs/INSTALL.md: short pointer after the Kubo step.
  • docs/SPECS.md: records the operator default under Preferred content sources.
  • docs/IMPLEMENTATION-PLAN.md: progress entry. A follow-up for later is an Admin probe that the published gateway really serves a pinned CID.

Tests

  • tests/operator-onboarding.test.ts: card visibility, checklist states, escaping, and the docs-URL override.
  • Full suite passed (179/179). Typecheck is clean. I also smoke-tested both pages on a throwaway Admin.

No Dash spent, no Platform writes, no device installs. Branched off main (745c57e). It doesn't touch PR #12. If #12 merges first, expect at most a trivial conflict in docs/DEPLOY.md / IMPLEMENTATION-PLAN.md.

Makes running your own Kubo (like the ronhelwig.com VPS node) the obvious default for every DecentSite operator, and makes it easy to publish it as the site's preferred content source. **Admin** - New `apps/admin/src/operator-onboarding.ts` checklist (no network calls). - Sites page: "Set up publishing storage" card while canonical storage is local test storage or Kubo is unreachable. Hidden once Kubo is ready. - Site page: "Your own IPFS source" card until Kubo is connected, the site lists an HTTPS gateway, and it has a preferred content source. A second independent source is shown as optional, never required. - Links to the DEPLOY/INSTALL guides from the checklist, Site settings → Preferred content sources, and Prepare review (when no sources are set). `DECENT_SITE_DOCS_URL` overrides the docs base for forks. **Docs** - `docs/DEPLOY.md`: new section "Your own IPFS node and preferred content source": install Kubo, `Gateway.NoFetch`, a read-only nginx/Caddy gateway (GET /ipfs/ only, never RPC 5001), port 4001, adding the gateway and multiaddr as preferred sources, checking pins after publish, an optional second Kubo node or Pinning Service API provider (token stays on the Kubo machine), and why public gateways (rate limits, notice pages) are a fallback only. The durable path is the owner's gateway plus the hash check. - `docs/INSTALL.md`: short pointer after the Kubo step. - `docs/SPECS.md`: records the operator default under Preferred content sources. - `docs/IMPLEMENTATION-PLAN.md`: progress entry. A follow-up for later is an Admin probe that the published gateway really serves a pinned CID. **Tests** - `tests/operator-onboarding.test.ts`: card visibility, checklist states, escaping, and the docs-URL override. - Full suite passed (179/179). Typecheck is clean. I also smoke-tested both pages on a throwaway Admin. No Dash spent, no Platform writes, no device installs. Branched off `main` (`745c57e`). It doesn't touch PR #12. If #12 merges first, expect at most a trivial conflict in `docs/DEPLOY.md` / `IMPLEMENTATION-PLAN.md`.
Admin shows an IPFS onboarding checklist on the Sites page while canonical
storage is local or Kubo is unreachable, and on each site page until Kubo is
connected and the site lists an HTTPS gateway as a preferred content source.
A second independent source is shown as optional. Checklist, Site settings
and Prepare review link to the setup guide (DECENT_SITE_DOCS_URL overrides
the docs base).

DEPLOY.md gains 'Your own IPFS node and preferred content source': install
Kubo, Gateway.NoFetch, read-only nginx/Caddy gateway (never RPC 5001),
port 4001, preferred sources, pin checks, optional second Kubo or pinning
service, and why public gateways are only a fallback. INSTALL.md points to
it; SPECS records the operator default.
Sign in to join this conversation.
No reviewers
No labels
feature request
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
rhelwig/DecentSite!14
No description provided.