docs: add Container Image guide and link it from the README - #14
Merged
Conversation
A dedicated docs/CONTAINER.md covers running the published GHCR image (quick start, Docker Compose, configuration, cache persistence, tool selection, MCP client wiring, provenance). The README gains a short Container Image section that links to it — GHCR renders the repo README on the package page, so the link surfaces there, keeping the SDK-focused README uncluttered. Co-Authored-By: Claude Opus 4.8 <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.
Add a dedicated Container Image guide; link it from the README
Now that the MCP server ships as an official GHCR image, this adds a standalone
docs/CONTAINER.mdinstead of expanding the README with container internals.Why a separate guide + a link
GHCR renders the repo's root
README.mdon the container package page — there's no per-packageREADME override. So rather than bloat the README (or duplicate content), the README gets a short
Container Image section whose main job is to link to the full guide. That link surfaces on the
package page, giving container users a clear entry point while the README stays SDK-focused.
What's in the guide
ghcr.io/codemug/aiofmp-mcp-server,latest/ per-release, multi-arch)docker run) and Docker Compose (pull vs.--build,AIOFMP_IMAGE_TAGpinning)FMP_API_KEY,AIOFMP_CACHED,AIOFMP_CACHE_FILE_PATH,AIOFMP_MCP_TOOLS/AIOFMP_MCP_EXCLUDE_TOOLS), plus the note that transport/host/port/log-levelare command args (the image CMD overrides
MCP_*env)/cachevolume;AIOFMP_CACHE_DIRoverride)http://localhost:3000/mcp/), and image provenanceThe README's container link is an absolute URL so it resolves from the GHCR package page (relative
links there are unreliable). All in-guide links to
README.mdsections and repo files were verified toresolve.
docs:— no version bump.🤖 Generated with Claude Code