Repository navigation
docs: document container image tags and mount points - #59142
ashrafumair111-lab wants to merge 5 commits into
Conversation
The intro page only listed a versioned image tag, so readers could not find the published package or know which directories to mount. Link the GitHub Packages page and add a table covering `/root` for configuration persistence and `/workspace` for the project mount, with a runnable example. Closes anomalyco#59113
There was a problem hiding this comment.
This looks good. It's a docs-only change, so there was nothing to run. I checked it against packages/cli/Dockerfile: the image runs as root with no WORKDIR, so keeping config under /root and passing -w /workspace for the project is correct. Nothing on the site links to the old #docker anchor. The public API is unchanged.
Two small points, neither blocking:
- The example tag
2.0.0was already on the page before this change. The newest v2 release is2.1.4, so you may want to bump it in both places. - #57233 also edits this section of
index.mdx, so whichever merges second will need a small conflict fix.
|
Hi! About the changes related to container's docs, may I suggest/ask a couple of stuff?
|
|
Thanks for the feedback, and no need to apologise — the v2 docs live under Your run command suggestion hasn't come through on this PR yet (no review comment so far). Please post it on
docker run --rm -p 4096:4096 \
-v opencode-config:/root \
-v "$PWD:/workspace" -w /workspace \
ghcr.io/anomalyco/opencode:2.1.4 serve --hostname 0.0.0.0 --port 4096I verified all three on A minimal
Better as a follow-up container page once those settle. The |
Hello @ashrafumair111-lab, excuse me, I was trying commands as you mentioned, but I wasn't able to run them or use them properly.
May I kindly ask you/suggest, to add a really few lines, on how to run such commands effectively using containers to allow/be able to use the web interface? |
Issue for this PR
Closes #59113
Type of change
What does this PR do?
The intro page described the container image in a single line with a versioned tag, with no link to where images are published and no guidance on what to mount. This replaces that line with:
docker runexample with standard volume mounts./root(for persistent configuration, agent settings, and credentials) and/workspace(for project mounting), along with guidance to keep them separate.The heading changes from "Docker" to "Container", as suggested in the issue.
How did you verify your code works?
@mdx-js/mdxandremark-gfm.packages/cli/Dockerfile.#dockeranchor.Screenshots / recordings
N/A (Documentation change)
Checklist
Added by the opencode bot (AI-generated).
Related: #55558, #57228