docs(docs): add the Production checklist page and point the copies at it - #476
Merged
Conversation
Phase-2 documentation restructure — another additive "new page", and the home the audit said the security-hardening list never had. The list (auth on, encryption key, HTTPS, trust-proxy) was copied across the README, deployment, authentication, privacy, SECURITY.md and the Docker Hub page, with no single source. - Add apps/docs/production-checklist.md (Operate, 585 words): the ordered "before you expose it" steps, a "what Piwi already does for you" section (non-root container, scrypt hashing, hashed API keys, rate limiting, env-secret handling, AES-256-GCM, forward-only migrations), and the optional share-links/retention notes. The secret-generation one-liner is the shared snippet include, not another literal copy. - Point the two most prominent copies at it: deployment's "Security" section keeps its heading (privacy deep-links the anchor) and the non-root fact but drops the duplicated bullets; the README's "before you expose it" keeps its teaser bullets and adds a link. Authentication's "Security considerations" keeps only its auth-specific facts (scrypt, rate limiting, trust-proxy) and links the checklist for the generic steps. - Add a "Production checklist" entry to the "Running your instance" sidebar. No existing page URL or heading anchor changes (deployment#security stays). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GKdmqq1BRUPeH5BxSPV5Jj
Contributor
Coverage Report for Reporter (./packages/reporter)
File CoverageNo changed files found. |
Contributor
Coverage Report for Application (./apps/application)
File CoverageNo changed files found. |
3 tasks
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
2 participants
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.
What & why
Phase-2 restructure — another additive new page, and the home the audit said the security-hardening list never had. That list (auth on, encryption key, HTTPS, trust-proxy) was copied across the README, deployment, authentication, privacy,
SECURITY.mdand the Docker Hub page, with no single source.apps/docs/production-checklist.md(Operate, 585 words): the ordered "before you expose it" steps, a "what Piwi already does for you" section (non-root container, scrypt hashing, hashed API keys, rate limiting, env-secret handling, AES-256-GCM, forward-only migrations), and the optional share-links / retention notes. The secret-generation one-liner is the sharedsnippets/secret.shinclude, not another literal copy.deployment#security) and the non-root fact but drops the duplicated bullets; the README's "before you expose it" keeps its teaser bullets (and its guarded secret one-liner) and adds a link; authentication's "Security considerations" keeps only its auth-specific facts (scrypt, rate limiting, trust-proxy) and links the checklist for the generic steps.SECURITY.mdandprivacy.mdkeep their own audience-specific content (the vulnerability-reporting policy; the "secrets at rest" explanation) and are linked from the checklist rather than gutted. No existing page URL or heading anchor changes.How was it tested?
npm run docs:build— green; the dead-link check validates every anchor (deployment#backups,configuration#authentication,storage#data-retention,deployment#securitystill resolves for privacy's link).npx vitest run tests/unit/docs-drift.test.ts— 124 passing (thesecret.shbyte-equality guard still holds — the README keeps its one-liner).Checklist
type(scope): subject)🤖 Generated with Claude Code
https://claude.ai/code/session_01GKdmqq1BRUPeH5BxSPV5Jj
Generated by Claude Code