docs: design doc and deployment guides for three use cases#7
Merged
Conversation
New documentation for technical audiences evaluating zerolease: - design.md: Threat model, trust boundaries, core abstractions, design decisions (why deny-by-default, why newtypes, why the proxy doesn't terminate TLS), and what this is not. - guide-embedded.md: Integrating zerolease into a Rust app like zeroclaw. In-process vault with rusqlite, per-tool leasing pattern, notes on adapting zeroclaw's built-in vault. - guide-cloud-service.md: Running the vault as a server with PostgreSQL/AWS SM backends. Authenticator implementation, client usage, monitoring. - guide-vm-deployment.md: Full lifecycle of the QEMU VM deployment. Image requirements (no credentials), iptables network jail, boot sequence (proxy → provision → source env → claude), proxy hardening, security assumptions and residual risks, what the Claw provides. Removes 11 stale implementation spec files from the pre-workspace era and the old deployment-architecture.md (superseded by the VM guide).
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.
Summary
Replaces 11 stale implementation spec files and the old deployment architecture doc with four focused documents for a technical audience evaluating zerolease for security-sensitive deployments.
New docs
design.md — The foundational document. Covers:
guide-embedded.md — For integrating zerolease into a Rust application:
guide-cloud-service.md — For running the vault as a shared server:
guide-vm-deployment.md — The full production deployment with VMs:
Removed
Test plan