docs(operating): object storage first-class, and a disaster-recovery runbook - #167
Merged
Merged
Conversation
…runbook The S3 file store existed and worked with R2, MinIO and Spaces, and no guide said how to adopt it. Where uploads go now carries the provider endpoint table, the fact that the bucket stays private because the board serves every file through its own permission checks, and the local-to-S3 migration — copy, cut over, copy again to close the gap, verify before deleting anything. docs/disaster-recovery.md is the new full-loss runbook: the three artifacts recovery consumes and what losing each one costs, the order of operations from provisioning to DNS cutover, the partial losses that have shorter answers, and the rehearsal that turns the page from a hope into a measured recovery time. Registered in the manifest and linked from the index, the backup section, self-hosting and the scaling guide. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RZsbkeeetS4Fh9nvGLC97M
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.
Two documentation gaps at the operations layer, closed. The S3 file store has existed and worked (R2, MinIO, Spaces via
S3_ENDPOINT) with no guide saying how to adopt it, and there was no page for the day the server is gone.Object storage, documented for real
operating.md§ Where uploads go gains:S3_REGION/S3_ENDPOINTfor AWS, Cloudflare R2, DigitalOcean Spaces and MinIO — plus the path-style-addressing note and the scope the credential needs..uploads/avatars/7.webp→ objectavatars/7.webp; the database stores keys, not URLs), so the migration is copy → cut over on web and worker → incremental second copy to close the upload window → verify before deleting the volume. The reverse migration gets a sentence.scaling.md's uploads step now links this as the canonical procedure.The disaster-recovery runbook
New
docs/disaster-recovery.md, written to be followed under stress:AUTH_SECRETstrands every enrolled authenticator app; sessions survive because they are hashed tokens in the database).Registered in the manifest under Running the server and linked from the docs index, the backup section,
self-hosting.mdandscaling.md; the root README table is regenerated from the manifest.site:docs:check,docs:index:checkand lint pass. Docs only — no code changes.🤖 Generated with Claude Code
https://claude.ai/code/session_01RZsbkeeetS4Fh9nvGLC97M
Generated by Claude Code