Skip to content

docs: add "source checkout → release images" upgrade path#254

Merged
VijitSingh97 merged 1 commit into
mainfrom
docs/source-to-release-upgrade-path
Jun 15, 2026
Merged

docs: add "source checkout → release images" upgrade path#254
VijitSingh97 merged 1 commit into
mainfrom
docs/source-to-release-upgrade-path

Conversation

@VijitSingh97

Copy link
Copy Markdown
Collaborator

Spun out of moving pithead-prod onto a release: there was no documented way to convert a git clone (which builds :dev locally — the dev · branch @ commit badge) to the published release images. This adds it.

  • operations.md — new Switching a source checkout to release images subsection under Updating the stack: backup -y → overlay the release bundle → rm -f build/*/Dockerfile (the switch that flips pithead from build to pull) → upgrade. Explains the build-vs-pull mechanism, how to reverse it (git checkout vX.Y.Z restores the Dockerfiles), and notes that upgrade now refuses a non-primary Monero address (1.0.3).
  • dashboard.md — the dev-badge explanation now links to the recipe (where someone confused by dev · … actually lands).
  • getting-started.md — the build from source alternative links to it ("changed your mind later?").

Docs-only; anchor verified against the new heading; README already cross-links to operations#updating-the-stack.

Document the in-place conversion from a `git clone` (`:dev`, badge reads
`dev · branch @ commit`) to the published release images, with the exact
steps that preserve config.json/.env/onion-keys/data — the procedure used
to move pithead-prod onto a release.

- operations.md: new "Switching a source checkout to release images"
  subsection under Updating the stack (backup → overlay bundle → drop the
  Dockerfiles to flip build→pull → upgrade), plus how to reverse it and a
  note that upgrade now requires a primary Monero address.
- dashboard.md: point the dev-badge explanation at the new recipe.
- getting-started.md: point the "build from source" alternative at it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@VijitSingh97 VijitSingh97 merged commit acaa484 into main Jun 15, 2026
11 checks passed
@VijitSingh97 VijitSingh97 deleted the docs/source-to-release-upgrade-path branch June 15, 2026 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant