mirror of
https://github.com/getpaseo/paseo.git
synced 2026-10-21 08:42:39 +00:00
* test(muse): record real host protocol fixtures * feat(muse): add built-in MSP provider Co-authored-by: millerben95 <millerben95@users.noreply.github.com> * fix(muse): expose provider settings in the app The daemon registered host settings without a client contribution, leaving sandbox, network, and workspace trust unreachable. Share the definition with a settings screen and expose it through Command Center even when installed plugins are disabled. * docs(muse): publish setup and provider support * test: correct runtime fixtures and restart readiness * fix(muse): hide reminder housekeeping from the timeline * fix(muse): use the official Muse Code mark Source: https://muse.ai/images/favicon/app-squiggle.svg Preserve the official silhouette path verbatim. Remove its gradient definition and use currentColor, scaling the original 100-unit coordinates into the 24-unit viewBox. Black silhouette renders match pixel-for-pixel. * fix(muse): adapt to current plugin APIs Use the screen API introduced with sidebar plugin items. Usage reports now come from source account discovery; remove the retired agent usage-reference request and headline marker, and exercise discovery through the existing provider fixtures. --------- Co-authored-by: millerben95 <millerben95@users.noreply.github.com>
167 lines
5.1 KiB
Markdown
167 lines
5.1 KiB
Markdown
---
|
||
title: Docker
|
||
description: Run the Paseo daemon and bundled web UI with the official Docker image.
|
||
nav: Docker
|
||
order: 6
|
||
category: Getting started
|
||
---
|
||
|
||
# Docker
|
||
|
||
The official Paseo Docker image runs the daemon and serves the bundled browser UI from the same HTTP origin. It is meant for servers, dev boxes, NAS devices, homelab hosts, and other places where you want Paseo running without the desktop app.
|
||
|
||
Docker images follow the stable Paseo release cadence. `ghcr.io/getpaseo/paseo:latest` points at the latest stable release, not an arbitrary `main` build.
|
||
|
||
```bash
|
||
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:
|
||
|
||
```text
|
||
http://localhost:6767
|
||
```
|
||
|
||
If you set `PASEO_PASSWORD`, use that same password when adding the direct daemon connection in the web UI, mobile app, or CLI.
|
||
|
||
## What the image includes
|
||
|
||
The image:
|
||
|
||
- installs the Paseo daemon and CLI
|
||
- serves the bundled web UI
|
||
- listens on `0.0.0.0:6767` inside the container
|
||
- stores daemon state under `/home/paseo/.paseo`
|
||
- runs the daemon and launched agents as the non-root `paseo` user
|
||
|
||
The image does not bundle agent CLIs such as Claude Code, Codex, OpenCode, Copilot, Pi, or Muse Code. Add the agents you use with a small child image.
|
||
|
||
Host-side CLI commands select the container explicitly, for example `paseo project ls --host 127.0.0.1:6767`. Without an endpoint selector the CLI looks for a local home’s supervisor. Container environment settings are deployment overrides; worker restart preserves them. Your container manager owns full supervisor replacement.
|
||
|
||
## Docker Compose
|
||
|
||
```yaml
|
||
services:
|
||
paseo:
|
||
image: ghcr.io/getpaseo/paseo:latest
|
||
container_name: paseo
|
||
restart: unless-stopped
|
||
ports:
|
||
- "6767:6767"
|
||
environment:
|
||
PASEO_PASSWORD: "change-me"
|
||
# PASEO_HOSTNAMES: "paseo.example.com,.lan"
|
||
volumes:
|
||
- ./paseo-home:/home/paseo
|
||
- ./workspace:/workspace
|
||
```
|
||
|
||
Start it:
|
||
|
||
```bash
|
||
docker compose up -d
|
||
```
|
||
|
||
## Install agent CLIs
|
||
|
||
Create a child image for the providers you want available:
|
||
|
||
```Dockerfile
|
||
FROM ghcr.io/getpaseo/paseo:latest
|
||
|
||
USER root
|
||
RUN npm install -g @openai/codex @anthropic-ai/claude-code opencode-ai
|
||
```
|
||
|
||
Build it:
|
||
|
||
```bash
|
||
docker build -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 mounted-volume setup, then drops the daemon and launched agents to the non-root `paseo` user.
|
||
|
||
You can authenticate agents either by passing provider environment variables or by running the provider login flow inside the container:
|
||
|
||
```bash
|
||
docker exec -it --user paseo paseo codex
|
||
docker exec -it --user paseo paseo claude
|
||
```
|
||
|
||
Agent credentials persist in `/home/paseo`.
|
||
|
||
## Volumes
|
||
|
||
Mount two paths for most deployments:
|
||
|
||
| Mount | Purpose |
|
||
| ------------- | ------------------------------------------------------------------------- |
|
||
| `/home/paseo` | Paseo state plus agent config and credentials such as `.codex`, `.claude` |
|
||
| `/workspace` | Code that Paseo and launched agents can read and write |
|
||
|
||
On Linux, the built-in `paseo` user is uid/gid `1000:1000`. Make mounted directories writable by that user, or run the container with Docker's `--user` / Compose `user:` option.
|
||
|
||
## Reverse proxy
|
||
|
||
Forward normal HTTP traffic and WebSocket upgrades to the container.
|
||
|
||
Caddy:
|
||
|
||
```caddy
|
||
paseo.example.com {
|
||
reverse_proxy 127.0.0.1:6767
|
||
}
|
||
```
|
||
|
||
Nginx:
|
||
|
||
```nginx
|
||
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 Paseo by DNS name, allow that host:
|
||
|
||
```yaml
|
||
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. Use HTTPS at your reverse proxy for browser access outside localhost.
|
||
|
||
The static web UI is public on the daemon origin. The daemon API and WebSocket are protected by password auth when configured.
|
||
|
||
Agents can access whatever you mount into `/workspace` and whatever credentials you place in `/home/paseo`. Keep those mounts scoped to what the agents should be able to use.
|
||
|
||
See [Security](/docs/security) for the full daemon trust model.
|
||
|
||
## Troubleshooting
|
||
|
||
- **The 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 make sure 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:** run `docker logs paseo`, or inspect `/home/paseo/.paseo/daemon.log` inside the container.
|