Repository navigation
docs: explain bootstrap and CI publishing keys in quick start - #155
Merged
Merged
Conversation
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.
The README quick start starts the server before explaining API-key bootstrap, and publishing setup does not show how to obtain a registered CI credential. A database without keys permits unauthenticated writes, while an arbitrary string entered as a CI secret will fail once authentication is enabled.
Move bootstrap and authenticated publishing-key creation into Quick Start. Explain the server versus client environment variables, host CLI prerequisite, one-time issued secret, GitHub secret setup, shared key permissions, and rotation without database reset or restart. Replace command-line credential examples with hidden Bash input, correct key endpoint paths, and explicitly bind the local .NET example to port 8080.
Validation: Release build passed with zero warnings/errors; all 236 tests passed; copyright-header verification and diff checks passed. An isolated 0.4.1 container/CLI smoke verified startup, authentication, issued-key creation, metadata-only listing, replacement-key authentication, revocation, last-key protection, expiration, and bootstrap changes ignored after restart. The .NET startup command was also exercised in an isolated temporary data directory.
Documentation only; generic examples contain no credentials or personal infrastructure details.