README: using the Image in a coding project #9

New issue

Closed

opened 2026-09-30 13:14:53 +00:00 by piscis · 0 comments

piscis commented

2026-09-30 13:14:53 +00:00

Owner

What to build

Replace the empty README with documentation for Consumers. The Image is public at code.vicoli.de/vicoli-oss/forgejo-mcp and needs no docker login (ADR 0004).

What this is: a multi-arch build of Upstream, with links to Upstream, the Codeberg mirror note and the licenses: this repo is MIT, and the Image contains Upstream's GPL-3.0 software. Its source is Upstream at the commit in the Pin.
Quick start: docker run -i --rm with FORGEJO_URL and FORGEJO_ACCESS_TOKEN taken from the environment.
Claude Code setup: a .mcp.json snippet and the equivalent claude mcp add command. The token is passed through from the environment and never written into the file.
HTTP mode: overriding CMD to use streamable HTTP, including the required host and allowed-hosts settings and the client URL.
Tags: which tag to pin (:3 vs :3.2.0-rN), how Rebuilds work, and how bumps arrive (Renovate PRs, #8).
For maintainers: where the Pin lives (pin.env) and how to raise it for a Rebuild, building and smoke-testing locally, and how a release happens.

Acceptance criteria

Every Consumer snippet has been run against the published Image and works as written, without docker login
No token appears in any config snippet; all tokens come from the environment
The README uses the glossary terms consistently

Blocked by

Context: see GLOSSARY.md (Upstream, Upstream Version, Image, Rebuild, Consumer, Pin) and docs/adr/ (0001 build from Upstream source for multi-arch, 0002 canonical Upstream not the Codeberg mirror, 0003 tag scheme and immutable Rebuild tags, 0004 public org vicoli-oss).

## What to build Replace the empty README with documentation for Consumers. The Image is public at `code.vicoli.de/vicoli-oss/forgejo-mcp` and needs no `docker login` (ADR 0004). - **What this is:** a multi-arch build of Upstream, with links to Upstream, the Codeberg mirror note and the licenses: this repo is MIT, and the Image contains Upstream's GPL-3.0 software. Its source is Upstream at the commit in the Pin. - **Quick start:** `docker run -i --rm` with `FORGEJO_URL` and `FORGEJO_ACCESS_TOKEN` taken from the environment. - **Claude Code setup:** a `.mcp.json` snippet and the equivalent `claude mcp add` command. The token is passed through from the environment and never written into the file. - **HTTP mode:** overriding CMD to use streamable HTTP, including the required host and allowed-hosts settings and the client URL. - **Tags:** which tag to pin (`:3` vs `:3.2.0-rN`), how Rebuilds work, and how bumps arrive (Renovate PRs, #8). - **For maintainers:** where the Pin lives (`pin.env`) and how to raise it for a Rebuild, building and smoke-testing locally, and how a release happens. ## Acceptance criteria - [ ] Every Consumer snippet has been run against the published Image and works as written, without `docker login` - [ ] No token appears in any config snippet; all tokens come from the environment - [ ] The README uses the glossary terms consistently ## Blocked by - #7 Context: see `GLOSSARY.md` (Upstream, Upstream Version, Image, Rebuild, Consumer, Pin) and `docs/adr/` (0001 build from Upstream source for multi-arch, 0002 canonical Upstream not the Codeberg mirror, 0003 tag scheme and immutable Rebuild tags, 0004 public org `vicoli-oss`).

piscis added the

ready-for-agent

label

2026-09-30 13:14:53 +00:00

piscis added a new dependency

2026-09-30 13:14:54 +00:00

#7 Publish the Image on push to main

piscis referenced this issue

2026-09-30 13:47:16 +00:00

Point the repo at vicoli-oss and add an MIT license #14

piscis referenced this issue

2026-09-30 13:47:29 +00:00