docs(README): document auto-update behavior and admin endpoint#51
Merged
Conversation
Adds an "Auto-Update" section before "Project structure" covering: - Startup log lines emitted by spur-cloud-api when a newer release is available - The `GET /api/admin/update-check` admin endpoint with example request/response - The `[update]` config block (`check_on_startup`, `channel`, `cache_dir`) and how to disable for air-gapped deployments - A short table on how to actually apply updates for Docker/K8s, binary/systemd, and frontend deployments Also adds the admin endpoint row to the API reference table. The service intentionally does not self-replace — updates are an operator action (image pull or binary replacement + restart). This section makes that explicit alongside the new release flow. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <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
1 participant
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
Adds an "Auto-Update" section to the README covering the mechanism shipped in #46 and now live in v0.3.0:
spur-cloud-apiwhen a newer release is publishedGET /api/admin/update-checkadmin endpoint with an example request and response[update]config block (check_on_startup,channel,cache_dir) plus how to disable for air-gapped deploymentsAlso adds
/api/admin/update-checkto the API reference table.The service intentionally does not self-replace — operators apply updates via image pull or binary replacement. This section makes that explicit.
Pure docs change.
🤖 Generated with Claude Code