docs: correct volume references after the mitmproxy-public split - #104
Merged
Merged
Conversation
#97 moved the agent-facing files onto a separate `mitmproxy-public` volume so the agent can no longer read the CA private key (#25), but the README still described the pre-split layout: it claimed `sandcat.env` lives on `mitmproxy-config` at `/home/mitmproxy/.mitmproxy/sandcat.env`, showed the CA cert and `sandcat.env` inside `mitmproxy-config` in the volumes diagram, and pointed the agent's read-only mount at that volume. Corrected throughout: the addon writes `/mitmproxy-public/sandcat.env` and `/mitmproxy-public/cursor-cli-config.json`, the agent mounts `mitmproxy-public` read-only at `/mitmproxy-config/` (hence paths inside the agent keep that prefix), and `mitmproxy-config` stays private to mitmproxy and wg-client. The volumes diagram now shows both volumes and who mounts which. Co-Authored-By: Claude Opus 5 (1M context) <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.
Follow-up to #97 (which fixed #25). No open issue tracks this, so there is no close keyword.
Summary
#97 split the agent-facing files onto a separate
mitmproxy-publicvolume so the agent can no longer read the CA private key, but the README was left describing the pre-split layout. Spotted while integration-testing #101, which touchessandcat.envgeneration.Stale claims corrected:
sandcat.envwas described as living onmitmproxy-configat/home/mitmproxy/.mitmproxy/sandcat.env; the addon actually writes/mitmproxy-public/sandcat.env(SANDCAT_ENV_PATH).cursor-cli-config.json— now/mitmproxy-public/.mitmproxy-configread-only at/mitmproxy-config/" — they mountmitmproxy-publicat that path. The path prefix inside the agent is unchanged, which is exactly what made this easy to miss; the text now says so explicitly.mitmproxy-ca-cert.pemandsandcat.envinsidemitmproxy-config, with the agent reading from it. It now shows both volumes, their real contents, and who mounts which.compose-agent.ymldescription and the startup-sequence intro likewise pointed at the wrong volume.Docs only — no code or template changes.
Verification
mitmproxy-config/mitmproxy-publicmention in the README re-checked againstcompose-proxy.yml,compose-agent.yml, and the addon's path constants.fixtures/pass-cli/README.mdand a command-output string).🤖 Generated with Claude Code