Files
paseo/docs/docker.md
Mohamed Boudra 2c9db5279c Run Paseo from an official Docker image (#1740)
* Add Docker images and agent Docker Mods

Ship official container images that run the Paseo daemon headless. One
Dockerfile parametrized by BASE_IMAGE covers Debian 12/13, Ubuntu 22.04/24.04
and Alpine; it bundles Node 22, the npm-published server + CLI, a vendored
s6-overlay as PID 1, and a small Docker Mods loader.

Agents are chosen at runtime via DOCKER_MODS (pipe-separated mod images). Each
mod is a FROM scratch image carrying only an install hook that runs
`npm install -g <agent-cli>`; the loader pulls the layers from the registry,
extracts them, and runs the hook before the daemon starts, so any requested
agent is on PATH when Paseo probes provider availability.

- docker/base: Dockerfile, install scripts, s6 services, mods loader
- docker/mods/*: claude-code, codex, copilot, opencode, pi
- docker/docker-compose.example.yml + docker/README.md
- .github/workflows/docker.yml: multi-arch (amd64/arm64) buildx matrix,
  publishes to ghcr.io/getpaseo on version tags
- docs/docker.md + CLAUDE.md docs index row

* feat(docker): print pairing QR and link on daemon startup

Add an s6 oneshot service that waits for the daemon to listen, then runs
`paseo daemon pair` so the pairing QR code and link surface in the container
logs. Best-effort: never blocks boot, skips gracefully when relay is disabled.
Opt out with PASEO_PAIRING_QR=0.

* build(docker): add Arch image support

* ci(docker): build Arch without Buildx

* docs(docker): document paseo env contract

* feat(docker): add opt-in sudo mode

* docs(docker): link env references

* fix(docker): create agent config dirs

* fix(docker): default home to /home/paseo

* docs(docker): document agent auth setup

* docs(docker): document relay port setup

* fix(docker): install Node from tarball

* docs: add Docker quick start

* docs(docker): remove legacy home example

* docs(docker): set container hostname

* fix(docker): prepare opencode storage

* fix(docker): allow paseo login shell

* fix docker opencode permissions

* ci(docker): use Node 24 actions

* fix(docker): install bzip2 runtime tools

* fix(docker): update Pi mod package

* fix(docker): quiet default daemon logs

* fix(docker): split home from state

Docker images now keep HOME at /home/paseo and store Paseo daemon state under /home/paseo/.paseo by default.

Existing volumes can keep the old layout by setting PASEO_HOME=/home/paseo.

* fix(docker): keep mods out of paseo home

* ci(docker): skip alpine arm64 builds

* fix(docker): address review findings

* fix(docker): verify s6 overlay downloads

* fix(docker): honor custom healthcheck port

* fix(docker): fail on mod extraction errors

* feat(docker): add official container image

Ship a focused daemon image with the bundled web UI enabled and document extending it with agent CLIs.

* ci(docker): publish images only on stable releases

* fix(docker): check daemon health over HTTP

---------

Co-authored-by: Herbrant <cdavide98carnemolla@gmail.com>
2026-06-26 14:48:13 +08:00

6.6 KiB

Running Paseo in Docker

Paseo publishes a container image for running the daemon on a server, VM, NAS, or homelab box. The image also serves the bundled browser web UI, so one container gives you both the daemon API and a self-hosted UI.

The image source lives in docker/.

How it works

The official image:

  • installs @getpaseo/server and @getpaseo/cli from npm
  • runs the daemon as the non-root paseo user
  • listens on 0.0.0.0:6767 inside the container
  • enables the bundled daemon web UI with PASEO_WEB_UI_ENABLED=true
  • stores daemon state and agent credentials under /home/paseo
  • leaves agent CLIs out of the base image

Open the container's HTTP origin, for example http://localhost:6767, to load the web UI. The served app receives a same-origin connection hint and connects back to that daemon. Static UI files load without daemon auth; API and WebSocket requests still require PASEO_PASSWORD when one is configured.

Quick Start

docker run -d --name paseo \
  -p 6767:6767 \
  -e PASEO_PASSWORD=change-me \
  -v "$PWD/paseo-home:/home/paseo" \
  -v "$PWD:/workspace" \
  ghcr.io/getpaseo/paseo:latest

Then open:

http://localhost:6767

If you set PASEO_PASSWORD, enter the same password when adding the direct daemon connection in the web UI or another Paseo client.

Docker Compose

Use docker/docker-compose.example.yml:

cp docker/docker-compose.example.yml docker-compose.yml
$EDITOR docker-compose.yml
docker compose up -d

Minimal example:

services:
  paseo:
    image: ghcr.io/getpaseo/paseo:latest
    restart: unless-stopped
    ports:
      - "6767:6767"
    environment:
      PASEO_PASSWORD: "change-me"
    volumes:
      - ./paseo-home:/home/paseo
      - ./workspace:/workspace

Installing Agents

The base image does not preinstall Claude Code, Codex, OpenCode, Copilot, Pi, or other agent CLIs. That keeps the default image small and avoids coupling Paseo releases to third-party agent release cycles.

Create a child image for the agents you use:

FROM ghcr.io/getpaseo/paseo:latest

USER root
RUN npm install -g @openai/codex @anthropic-ai/claude-code opencode-ai

Build it:

docker build -f Dockerfile -t paseo-with-agents .

Then use image: paseo-with-agents in Compose.

Leave the child image user as root. The base entrypoint uses root only for first-run directory setup, then drops the daemon and launched agents to the non-root paseo user.

An example child image is in docker/Dockerfile.agents.example.

You can also mount credentials from the host or run agent login once inside the container:

docker exec -it --user paseo paseo codex
docker exec -it --user paseo paseo claude

Agent credentials and config persist in /home/paseo, alongside daemon state. Provider environment variables such as OPENAI_API_KEY, ANTHROPIC_API_KEY, OPENAI_BASE_URL, or ANTHROPIC_BASE_URL can be passed through docker run -e or compose.environment; Paseo passes them to launched agents.

Volumes

Mount Purpose
/home/paseo Paseo state under .paseo plus agent config such as .codex, .claude
/workspace Code that Paseo and launched agents can read and write

The image defaults:

Variable Default
HOME /home/paseo
PASEO_HOME /home/paseo/.paseo
PASEO_LISTEN 0.0.0.0:6767

If you bind-mount host directories on Linux, make sure the container user can write them. The built-in paseo user has uid/gid 1000:1000. For a different host uid/gid, either adjust ownership on the mounted directories or run the container with Docker's --user / Compose user: option.

Reverse Proxies

When serving Paseo behind a reverse proxy, forward normal HTTP requests and WebSocket upgrades to the same daemon port.

Caddy example:

paseo.example.com {
  reverse_proxy 127.0.0.1:6767
}

Nginx example:

server {
    listen 443 ssl;
    server_name paseo.example.com;

    location / {
        proxy_pass http://127.0.0.1:6767;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

If you reach the daemon by DNS name, set PASEO_HOSTNAMES so host-header validation allows that name:

environment:
  PASEO_HOSTNAMES: "paseo.example.com,.lan"

IPs and localhost are allowed by default.

Security

  • Set PASEO_PASSWORD for any published port or network-reachable deployment.
  • Prefer HTTPS at the reverse proxy for direct browser access.
  • Use the Paseo relay for untrusted networks or mobile access when you do not want to expose the daemon port directly.
  • The container is the isolation boundary for agents. Agents can read and write whatever you mount into /workspace and whatever credentials you place in /home/paseo.
  • The bundled web UI static files are public on the daemon origin. The daemon API and WebSocket remain protected by password auth when configured.

See SECURITY.md for the daemon trust model.

Building Locally

docker build -t paseo:local docker/base

To bake a specific published npm version:

docker build \
  --build-arg PASEO_VERSION=0.1.102 \
  -t paseo:0.1.102 \
  docker/base

The Docker workflow builds the image on pull requests and on main as a non-publishing check. GHCR publishing follows the stable release cadence: only a stable vX.Y.Z tag push publishes ghcr.io/getpaseo/paseo:X.Y.Z and ghcr.io/getpaseo/paseo:latest. Beta tags and manual workflow runs build for validation only.

The published image is multi-arch for linux/amd64 and linux/arm64.

Troubleshooting

  • The web UI loads but cannot connect: if PASEO_PASSWORD is set, add a direct connection with the same password.
  • 403 Host not allowed: set PASEO_HOSTNAMES to the DNS names you use.
  • Provider not available: install that agent CLI in a child image or mount a runtime where the binary is on PATH.
  • Permission errors in /workspace: make the mounted directory writable by uid/gid 1000:1000, or run the container as the host uid/gid.
  • Logs: inspect docker logs paseo or /home/paseo/.paseo/daemon.log inside the container.