Files
opencode-devbox/DOCKER_HUB.md
T
joakimp 113c9f0bb0 Infrastructure pass: CI smoke tests, floating versions, chown sentinel, generate-config script
Main changes:

- Extract opencode.json generation from entrypoint-user.sh into a
  standalone Python script (rootfs/usr/local/lib/opencode-devbox/
  generate-config.py). Preserves the never-overwrite-existing-config
  guarantee. Cuts entrypoint-user.sh from 176 to 97 lines.

- Install MemPalace via 'uv tool install' into an isolated venv at
  /opt/uv-tools/mempalace/ with a /usr/local/bin/mempalace-mcp-server
  wrapper, replacing the 'pip install --break-system-packages' escape
  hatch. The wrapper is what generate-config.py references in the
  auto-generated opencode.json. Also fix 'mempalace init' in
  entrypoint-user.sh to use --yes so first-start initialization isn't
  interactive (this used to hang or print prompts into the user's
  terminal). Gated by INSTALL_MEMPALACE build arg (default true) so
  users who don't need AI memory can shave ~300 MB.

- Sentinel-file pattern in entrypoint.sh volume-ownership loop: write
  .devbox-owner after a successful chown -R, skip the recursive walk
  on subsequent starts when the sentinel matches FINAL_UID:FINAL_GID.
  Cuts multi-second startup costs to milliseconds on large volumes
  (nvim plugins, palace data). UID changes still trigger a full chown.

- Float all GitHub/Gitea-hosted binary versions: gosu, fzf, git-lfs,
  neovim, bat, eza, zoxide, uv, gitea-mcp now default to 'latest' and
  resolve the newest upstream release at build time via the /releases/
  latest redirect. Go (go.dev JSON feed) and oh-my-opencode-slim (npm
  @latest) likewise. Intentional pins still in place: OPENCODE_VERSION,
  NODE_VERSION=22, DEBIAN_VERSION=trixie-slim. Each *_VERSION ARG
  accepts an explicit value to lock a specific version when needed.

- New scripts/smoke-test.sh verifies binary presence, opencode startup,
  entrypoint user drop, generate-config idempotency, bun's presence-
  per-variant, and image size against thresholds (2500 MB base, 3000
  MB OMOS). Prints resolved component versions as its first step so
  CI logs always record what got baked into a given image.

- New .gitea/workflows/validate.yml runs on push to main and PRs:
  single-arch amd64 build, smoke test, DOCKER_HUB.md sync check. Tag-
  triggered docker-publish.yml now smoke-tests each variant on amd64
  before the full multi-arch push.

- scripts/generate-dockerhub-md.py auto-generates DOCKER_HUB.md from
  README.md using explicit SECTION_RULES. --check mode fails CI when
  the committed file is out of sync. Enforces the 25 kB Docker Hub
  limit. Adding a new README section forces an explicit keep/drop/
  replace decision.

- Remove dead INSTALL_PYTHON build arg (was a no-op since mempalace
  added python3 unconditionally).
2026-04-28 23:28:43 +02:00

23 KiB
Raw Permalink Blame History

opencode-devbox — Docker Hub

Portable AI developer environment for opencode. Debian-based, with git, SSH, Node.js, AWS CLI v2, and common dev tools pre-installed.

Image Variants

Two image variants are published for each release:

Tag Description
latest / vX.Y.Z Base image — opencode, Node.js, AWS CLI, dev tools
latest-omos / vX.Y.Z-omos Base + oh-my-opencode-slim multi-agent orchestration and Bun

Both variants support linux/amd64 and linux/arm64.

NOTE: This file is auto-generated from README.md by scripts/generate-dockerhub-md.py. Edit README.md and regenerate rather than editing this file directly.

Quick Start

docker run -it --rm \
  -e ANTHROPIC_API_KEY=your-key \
  -e OPENCODE_PROVIDER=anthropic \
  -e GIT_USER_NAME="Your Name" \
  -e GIT_USER_EMAIL="you@example.com" \
  -v ~/projects:/workspace \
  -v ~/.ssh:/home/developer/.ssh:ro \
  joakimp/opencode-devbox:latest

This drops you straight into opencode with your project mounted at /workspace.

For an interactive shell first (useful for AWS SSO login):

docker run -it --rm \
  -e ANTHROPIC_API_KEY=your-key \
  -e OPENCODE_PROVIDER=anthropic \
  -v ~/projects:/workspace \
  -v ~/.ssh:/home/developer/.ssh:ro \
  joakimp/opencode-devbox:latest bash

Then run opencode when ready.

For docker-compose users, see the source repo for docker-compose.yml and .env.example templates.

Features

  • Debian trixie base — glibc, full PTY/terminal support
  • Configurable providers — Anthropic, OpenAI, AWS Bedrock via env vars
  • Host filesystem access — bind mount any directory as /workspace
  • SSH key forwarding — git push/pull to private repos
  • MCP server support — Node.js included for npx-based MCP servers
  • Non-root user — runs as developer with UID auto-matched to workspace owner (sudo available)
  • Python via uvuv package manager included; install Python on demand with uv python install
  • Rust via rustuprustup-init included; bootstrap Rust on demand with rustup-init -y
  • Optional runtimes — Python (apt), Go via build args (Node.js always included — required for opencode v1.x)
  • Multi-agent orchestration — optional oh-my-opencode-slim integration via build arg
  • AWS CLI v2 — built-in SSO/Bedrock authentication with headless device-code flow
  • Multi-arch — amd64 and arm64

Usage

Prerequisites

Bind-mounted directories must exist on the host before starting the container. Docker creates missing directories as root-owned, which causes permission issues.

# Required: workspace for your projects
mkdir -p ~/projects

# If mounting opencode config (recommended for persistent settings)
mkdir -p ~/.config/opencode

Connecting to the container

From your laptop, SSH into the remote server where Docker is running, then start the container:

# 1. SSH into the remote server
ssh user@remote-server

# 2. Navigate to the project
cd opencode-devbox

# 3. Start the container with an interactive shell
docker compose run --rm devbox bash

# You're now inside the container — run commands here
aws sso login --sso-session <your-sso-session> --use-device-code
opencode

Running modes

Interactive shell — enter the container, run multiple commands:

docker compose run --rm devbox bash

Direct to opencode — skips the shell, launches opencode immediately:

docker compose run --rm devbox

Background container — keep it running, attach when needed:

# Start in background
docker compose up -d

# Attach a shell to the running container
docker compose exec -u developer devbox bash

# Or run a single command inside it
docker compose exec -u developer devbox aws --version

run creates a new container (cleaned up with --rm). exec attaches to an already running one.

Configuration

Environment Variables

Variable Description Default
OPENCODE_PROVIDER LLM provider (anthropic, openai, amazon-bedrock) anthropic
OPENCODE_MODEL Model override Provider default
ANTHROPIC_API_KEY Anthropic API key
OPENAI_API_KEY OpenAI API key
AWS_REGION AWS region for Bedrock us-east-1
AWS_PROFILE AWS SSO profile name default
GIT_USER_NAME Git commit author name
GIT_USER_EMAIL Git commit author email
WORKSPACE_PATH Host path to mount .
SSH_KEY_PATH Host SSH key directory ~/.ssh
USER_UID Override container user UID Auto-detect from /workspace
USER_GID Override container user GID Auto-detect from /workspace
LANG System locale en_US.UTF-8
LANGUAGE Language priority list en_US:en
LC_ALL Override all locale settings en_US.UTF-8
EDITOR Default text editor nvim
ENABLE_OMOS Enable oh-my-opencode-slim multi-agent orchestration false
OMOS_TMUX Enable tmux pane integration for OMOS false
OMOS_SKILLS Install OMOS recommended skills on first run true
OMOS_RESET Force regenerate OMOS config on next start false

Custom opencode config

For full control over opencode settings (MCP servers, custom models, and — on the OMOS variant — oh-my-opencode-slim agents), mount the entire config directory from the host:

volumes:
  - ~/.config/opencode:/home/developer/.config/opencode

This persists all configuration changes across container restarts, including opencode.json, skills, and (on the OMOS variant) oh-my-opencode-slim.json. When an existing opencode.json is found, the OPENCODE_PROVIDER auto-config is skipped.

Portability note: The mounted config runs inside a Linux container. Any absolute paths inside opencode.json (for example, host-specific plugin entries like file:///usr/local/lib/node_modules/... or file:///opt/homebrew/...) will not resolve inside the container. Prefer bare package specifiers (e.g. "oh-my-opencode-slim") that resolve via node_modules lookup, which works on both macOS and Linux hosts.

Custom skills

Mount agent skills from the host:

volumes:
  - ~/.agents/skills:/home/developer/.agents/skills:ro

Neovim configuration

The image includes neovim 0.12 with EDITOR=nvim set by default. To use your own neovim config (and have plugins auto-install via lazy.nvim on first start), mount it from the host:

volumes:
  - ~/.config/nvim:/home/developer/.config/nvim:ro

Python development with uv

The image includes Python 3.13 (from Debian Trixie) and uv, a fast Python package manager that replaces pip, venv, and pyenv:

# Python 3.13 is available out of the box
python3 --version

# Use uv for package management
uv venv
uv pip install -r requirements.txt

# Or use uv's project workflow (reads pyproject.toml)
uv sync

# Run a Python script
uv run python script.py

# Install standalone Python tools
uvx ruff check .

# Install a newer Python version (persists with devbox-uv volume)
uv python install 3.14

Python installations are stored in ~/.local/share/uv/. To persist them across container restarts, add the devbox-uv named volume to your docker-compose.yml:

volumes:
  - devbox-uv:/home/developer/.local/share/uv

volumes:
  devbox-uv:

Project virtual environments (.venv) are stored in your workspace directory and persist automatically via the /workspace bind mount.

Rust development with rustup

The image includes rustup-init, the Rust toolchain installer. Rust is not pre-installed but can be bootstrapped on demand:

# One-time setup: install Rust toolchain (~300MB, persists with volumes)
rustup-init -y
source ~/.cargo/env

# Now use Rust normally
cargo new my-project
cargo build
cargo run

To persist Rust toolchains and cargo data across container restarts, add named volumes to your docker-compose.yml:

volumes:
  - devbox-rustup:/home/developer/.rustup
  - devbox-cargo:/home/developer/.cargo

volumes:
  devbox-rustup:
  devbox-cargo:

JavaScript and TypeScript

The base image includes Node.js 22 and npm — sufficient for most JavaScript and TypeScript development:

# Initialize a new project
npm init -y

# Install dependencies
npm install

# Run TypeScript (via tsx, ts-node, etc.)
npx tsx src/index.ts

# Use npx for one-off tools
npx tsc --init

The OMOS image variant also includes Bun, a faster JavaScript runtime and package manager:

bun init
bun install
bun run src/index.ts

Node modules are stored in your project directory under /workspace and persist automatically.

VS Code integration

VS Code can connect directly to a running opencode-devbox container for a full IDE experience with IntelliSense, debugging, and extensions running inside the container.

Local Docker (Docker running on your workstation):

  1. Install the Dev Containers extension
  2. Start the container: docker compose up -d
  3. In VS Code: Ctrl+Shift+P → "Dev Containers: Attach to Running Container" → select opencode-devbox

Remote Docker (Docker running on a remote server, e.g. via SSH):

  1. Install the Remote - SSH and Dev Containers extensions
  2. Connect to the remote host: Ctrl+Shift+P → "Remote-SSH: Connect to Host"
  3. On the remote host, start the container: docker compose up -d
  4. In VS Code (now connected to the remote): Ctrl+Shift+P → "Dev Containers: Attach to Running Container"

VS Code extensions installed inside the container persist as long as the container exists (not removed with docker compose down). For persistent extension storage across container recreations, add a named volume:

volumes:
  - devbox-vscode:/home/developer/.vscode-server

oh-my-opencode-slim (Multi-Agent Orchestration)

oh-my-opencode-slim adds a multi-agent layer on top of opencode — an Orchestrator delegates tasks to specialized agents (Explorer, Oracle, Librarian, Designer, Fixer), each configurable with different models and providers.

Setup

A pre-built OMOS image is available on Docker Hub as joakimp/opencode-devbox:latest-omos. Alternatively, build from source:

1. Build the image with OMOS support:

docker compose build --build-arg INSTALL_OMOS=true

This installs Bun and the oh-my-opencode-slim package into the image.

2. Enable in .env:

ENABLE_OMOS=true

3. Run as normal:

docker compose run --rm devbox

On first start, the entrypoint runs the oh-my-opencode-slim installer in non-interactive mode. It generates agent configuration at ~/.config/opencode/oh-my-opencode-slim.json inside the container. The default preset uses OpenAI models — edit the generated config or mount your own to customize.

OMOS Environment Variables

Variable Default Description
ENABLE_OMOS false Activate oh-my-opencode-slim on container start
OMOS_TMUX false Enable tmux pane integration (tmux is included in the base image)
OMOS_SKILLS true Install recommended skills (simplify, agent-browser, cartography)
OMOS_RESET false Force regenerate config on next start (backs up existing config)

Custom Configuration

If you mount the opencode config directory (see Custom opencode config above), the oh-my-opencode-slim.json file is included and persists across restarts. Edit it directly to control which models power each agent, fallback chains, council setup, and more.

See the oh-my-opencode-slim configuration docs for the full reference.

Verifying Agents

After starting opencode with OMOS enabled, run inside the opencode session:

ping all agents

All six agents should respond if your provider authentication is working.

AWS Bedrock Authentication

When using AWS Bedrock as your LLM provider, you need:

1. AWS config on the host

The container needs access to your ~/.aws/config with SSO session configuration. If you already have this on another machine, copy it:

scp -r user@other-machine:~/.aws ~/.aws

Or configure from scratch on the host:

aws configure sso

2. Mount ~/.aws into the container

Uncomment the AWS volume mount in docker-compose.yml:

- ~/.aws:/home/developer/.aws

Note: do not use :ro — SSO writes token cache files to this directory.

3. Authenticate inside the container

Since the container runs headless (no browser), use the device-code flow:

# Start the container
docker compose up -d
docker compose exec -u developer devbox bash

# Authenticate — prints a URL and code you open in your local browser
aws sso login --sso-session <your-sso-session> --use-device-code

# Once approved in the browser, start opencode
opencode

The --use-device-code flag outputs a URL and short code instead of trying to open a browser. Copy the URL into any browser (on your laptop, phone, etc.), enter the code, and complete the 2FA flow. The CLI in the container picks up the session automatically.

SSO sessions typically last 812 hours before requiring re-authentication. Since ~/.aws is mounted from the host, tokens persist across container restarts.

MemPalace — persistent AI memory

The image includes MemPalace, a local-first AI memory system that stores conversation history verbatim and retrieves it via semantic search. Nothing leaves your machine.

MemPalace adds ~300 MB to the image (chromadb, embedding model deps). If you don't use it, rebuild with --build-arg INSTALL_MEMPALACE=false to shrink the image.

Enabling persistence

Uncomment the palace volume in docker-compose.yml:

- devbox-palace:/home/developer/.mempalace

Without the volume, palace data lives in the container's writable layer and is lost on --force-recreate.

MCP integration with opencode

Add mempalace as an MCP server in your opencode.json (inside ~/.config/opencode/):

{
  "mcp": {
    "mempalace": {
      "type": "local",
      "command": ["mempalace-mcp-server"]
    }
  }
}

The image installs mempalace into an isolated uv tool venv at /opt/uv-tools/mempalace. The mempalace-mcp-server wrapper on PATH exec's the venv's Python with the mempalace.mcp_server module — you don't need to know about the venv to use it.

This gives opencode access to 29 MCP tools for searching memory, querying the knowledge graph, managing wings/rooms/drawers, and agent diaries.

Basic usage

# Mine project files into the palace
mempalace mine /workspace

# Mine conversation transcripts
mempalace mine ~/.local/share/opencode/ --mode convos

# Search memory
mempalace search "why did we switch to eno1"

# Load context for a new session
mempalace wake-up

Each workspace gets its own isolated "wing" — memories never leak between projects.

Storage

Two separate named volumes keep different data classes apart:

  • Palace data (~/.mempalace/): ChromaDB vectors, SQLite knowledge graph, drawers. This is your memory — back it up, treat it as precious. Persists via the devbox-palace named volume.
  • Embedding model cache (~/.cache/chroma/): ONNX model (~79 MB), downloaded automatically on first search. Disposable — blow it away and it re-downloads in ~4 seconds. Persists via the devbox-chroma-cache named volume so you don't re-download on every container recreation.
  • No API keys required for core functionality (local embeddings via ONNX).

Both volumes are commented out by default in docker-compose.yml — uncomment to enable:

- devbox-palace:/home/developer/.mempalace
- devbox-chroma-cache:/home/developer/.cache/chroma

Air-gapped environments: pre-populate the devbox-chroma-cache volume with the all-MiniLM-L6-v2/ model contents. The palace volume needs no pre-population.

Gitea MCP server

The image includes the official Gitea MCP server (gitea-mcp), providing 50+ MCP tools for interacting with self-hosted Gitea instances — repositories, issues, pull requests, releases, branches, wiki, and Actions.

Setup

  1. Create a Personal Access Token on your Gitea instance (Settings → Applications → Generate Token, scopes: repo, read:user).

  2. Add to your .env:

    GITEA_HOST=https://your-gitea-instance.example.com
    GITEA_ACCESS_TOKEN=your_token_here
    
  3. Enable the gitea MCP server in your opencode.json:

    {
      "mcp": {
        "gitea": {
          "type": "local",
          "command": ["gitea-mcp", "-t", "stdio", "--host", "{env:GITEA_HOST}"],
          "environment": {
            "GITEA_ACCESS_TOKEN": "{env:GITEA_ACCESS_TOKEN}"
          },
          "enabled": true
        }
      }
    }
    

The server is installed but disabled by default — it requires authentication to be useful.

Shell defaults

The image ships a baked .bash_aliases and .inputrc with quality-of-life defaults. On first container start they are copied from /etc/skel-devbox/ into /home/developer/ only if the target file does not already exist — so host bind-mounts and any version you've customized inside the container are never overwritten on upgrade.

Defaults you get out of the box:

  • Prefix history search on Up/Down arrows (type git , press Up, walk back through prior git ... commands only). Ctrl-Up / Ctrl-Down still step through full history.
  • Persistent history$HISTFILE points at ~/.cache/bash/history, backed by the devbox-shell-history named volume so history survives container recreation. Timestamps, 100 000 entries, dedup.
  • Case-insensitive tab completion, coloured completion lists, show-all-if-ambiguous.
  • Aliasesls/ll/la use eza, cat uses bat, gs/gd/gl for git, safe rm/mv/cp.
  • Integrationszoxide (z <fragment> to jump), fzf Ctrl-R / Ctrl-T key bindings.
  • Prompt marker[devbox] prefix so it's always obvious you're inside the container.

Overriding the defaults

Option A — bind-mount host files. Uncomment the bind-mount lines in docker-compose.yml:

- ~/.bash_aliases:/home/developer/.bash_aliases:ro
- ~/.inputrc:/home/developer/.inputrc:ro

Single-file bind-mount caveat (all platforms): Docker bind-mounts the file's inode, not its path. When editors like vim, nvim, VS Code, or sed -i save a file, they write to a temp file and rename() it over the original — creating a new inode. The container stays pinned to the old (now unlinked) inode and never sees the update. This is a kernel limitation (Docker #15793), not fixable by Docker. Append-only writes (echo "alias foo=bar" >> file) are safe because they modify the same inode. Workaround: mount the parent directory instead of the single file (e.g. ~/.config/devbox-shell:/home/developer/.config/devbox-shell:ro) and source files from there.

Option B — customize inside the container. Just edit ~/.bash_aliases or ~/.inputrc as normal. Pair this with a bind-mount or named volume on the home dir if you want the edits to survive container recreation.

Restoring or diffing defaults

The skel files remain available inside every container at /etc/skel-devbox/. Useful commands:

# See what the image currently ships
cat /etc/skel-devbox/.bash_aliases

# Diff your current config against the upstream defaults
diff ~/.bash_aliases /etc/skel-devbox/.bash_aliases

# Reset to the baked defaults
cp /etc/skel-devbox/.bash_aliases ~/.bash_aliases

# …or delete the file and recreate the container — the entrypoint
# copies from /etc/skel-devbox/ on next start if the target is absent
rm ~/.bash_aliases

Architecture

Host Machine
├── ~/projects/my-app  ──bind mount──▶  /workspace (container)
├── ~/.ssh             ──bind mount──▶  /home/developer/.ssh (ro)
├── ~/.aws             ──bind mount──▶  /home/developer/.aws (Bedrock SSO)
└── .env               ──env vars───▶  provider config + API keys

Container (Debian trixie)
├── opencode binary
├── oh-my-opencode-slim (optional — multi-agent orchestration plugin, includes Bun)
├── AWS CLI v2 (SSO + Bedrock auth)
├── neovim 0.12, tmux, htop, bat, eza, zoxide, uv, rustup, make, gcc, g++, rsync
├── git, git-crypt, age, ssh, ripgrep, fd, fzf, jq, curl, tree
├── Node.js (for MCP servers)
├── Bun (optional — included with oh-my-opencode-slim)
├── entrypoint.sh (UID adjustment, git config, provider setup)
└── /workspace ← your code lives here

Data persistence

Path in container Source Survives --rm? Contains
/workspace Host bind mount Yes Your project files
/home/developer/.ssh Host bind mount (ro) Yes SSH keys
/home/developer/.aws Host bind mount (if configured) Yes AWS credentials/SSO cache
/home/developer/.local/share/opencode Named volume devbox-data Yes Session history, memory
/home/developer/.local/state/opencode Named volume devbox-state Yes TUI settings (theme, toggles)
/home/developer/.cache/bash Named volume devbox-shell-history Yes Bash history ($HISTFILE), survives container recreate
/home/developer/.local/share/zoxide Named volume devbox-zoxide Yes Zoxide directory history (z <fragment> jump targets)
/home/developer/.local/share/nvim Named volume devbox-nvim-data Yes Neovim plugins, Mason LSP installs, Lazy plugin cache
/home/developer/.local/share/uv Named volume devbox-uv (if configured) Yes Python installs, uv tool installs
/home/developer/.rustup Named volume devbox-rustup (if configured) Yes Rust toolchains
/home/developer/.cargo Named volume devbox-cargo (if configured) Yes Cargo binaries, registry cache
/home/developer/.vscode-server Named volume devbox-vscode (if configured) Yes VS Code server and extensions
/home/developer/.config/opencode Host bind mount (if configured) Yes opencode.json, skills, plus oh-my-opencode-slim.json on the OMOS variant

opencode config (opencode.json) is auto-generated from OPENCODE_PROVIDER on each start. It sets provider and model only — no MCP servers. To persist config changes and use custom settings, mount the config directory from the host (see Custom opencode config above).

Source

MIT licensed. Source, issues, and docker-compose.yml templates: https://gitea.jordbo.se/joakimp/opencode-devbox