mirror of
https://github.com/nesquena/hermes-webui.git
synced 2026-05-19 13:47:04 +00:00
b57525241b
Combines PR #1428 (UID/GID alignment) with a broader Docker reliability pass that addresses recurring user reports about compose files not working. Constituent PR: - #1428 sunnysktsang - Align agent UID/GID with webui (fixes #1399). Two- and three-container compose files had agent at UID 10000 (image default) and webui at UID 1000 (WANTED_UID default), causing permission denied on shared hermes-home volume. All services now use ${UID:-1000}. Plus broader Docker UX overhaul: - All 3 compose files document HERMES_SKIP_CHMOD/HERMES_HOME_MODE escape hatches inline (the v0.50.254 fix wasn't surfaced for Docker users). - New .env.docker.example template covering UID/GID, paths, password, permission handling. UID/GID are uncommented with placeholder values per Opus advisor (so macOS users don't skim past). - New docs/docker.md - comprehensive guide: 5-min quickstart, failure mode table with one-line fixes, bind-mount migration, multi-container architecture diagram, macOS Docker Desktop VirtioFS note, link to community sunnysktsang/hermes-suite all-in-one image. - README Docker section rewritten - clearer quickstart, failure-mode table, link to docs/docker.md. Stale /root/.hermes references removed. Plus Opus pre-release advisor MUST-FIX: - HERMES_HOME_MODE has DIFFERENT semantics in the WebUI vs the agent image. WebUI: credential-file mode threshold (0640 allows group bits). Agent: HERMES_HOME directory mode (default 0700). 0640 on a directory has no owner-execute bit, so the agent can't traverse its own home and bricks. My initial draft recommended HERMES_HOME_MODE=0640 in agent service blocks - corrected to 0750 across all 4 surfaces (compose files, .env.docker.example, docs/docker.md). 3 regression tests pin the asymmetry. 12 regression tests total in test_v050260_docker_invariants.py. Full suite: 3627 passed, 0 failed. Nathan explicitly authorized merge with my own review + Opus only, no independent review needed.
134 lines
5.7 KiB
YAML
134 lines
5.7 KiB
YAML
# Two-container Docker Compose: Hermes Agent + Hermes WebUI
|
|
#
|
|
# QUICK START:
|
|
# docker compose -f docker-compose.two-container.yml up -d
|
|
# Open http://localhost:8787
|
|
#
|
|
# This runs the agent and web UI in separate containers connected via shared
|
|
# Docker volumes. The WebUI installs the agent's Python dependencies from the
|
|
# shared agent source volume at startup.
|
|
#
|
|
# WHEN TO USE THIS:
|
|
# - You want isolation between the agent gateway and the WebUI
|
|
# - You're already running hermes-agent in its own container
|
|
# - You don't need the dashboard (use docker-compose.three-container.yml for that)
|
|
#
|
|
# WHEN NOT TO USE THIS:
|
|
# - You hit "Permission denied" trying to share an existing ~/.hermes directory
|
|
# → use docker-compose.yml (single-container) instead, OR
|
|
# → keep this file but switch to NAMED VOLUMES (the default) instead of bind mounts
|
|
# - You're on Podman 3.4 or older without keep-id namespace support
|
|
# → see https://github.com/sunnysktsang/hermes-suite for an all-in-one image
|
|
#
|
|
# KNOWN LIMITATION (#681): tools triggered from the WebUI run in the WebUI
|
|
# container, not the agent container. If you need git/node/etc. on the
|
|
# WebUI's filesystem, install them in the WebUI image — or use a single-
|
|
# container setup where everything lives in one place.
|
|
#
|
|
# NOTE ON VOLUMES:
|
|
# This file uses named Docker volumes (hermes-home, hermes-agent-src) which
|
|
# work out of the box on every Docker installation. If you prefer bind mounts
|
|
# to share an existing host directory:
|
|
#
|
|
# volumes:
|
|
# hermes-home:
|
|
# driver: local
|
|
# driver_opts:
|
|
# type: none
|
|
# o: bind
|
|
# device: /home/youruser/.hermes
|
|
#
|
|
# When using bind mounts, BOTH containers must mount the same host path,
|
|
# AND your host directory must be readable by UID 1000 (the default). Run:
|
|
# id -u && id -g
|
|
# to find your host UID/GID, then put them in a .env file:
|
|
# echo "UID=$(id -u)" >> .env
|
|
# echo "GID=$(id -g)" >> .env
|
|
|
|
services:
|
|
hermes-agent:
|
|
image: nousresearch/hermes-agent:latest
|
|
container_name: hermes-agent
|
|
command: gateway run
|
|
ports:
|
|
# Gateway API — exposed on localhost only.
|
|
# Other containers on hermes-net reach it via http://hermes-agent:8642.
|
|
# Remove 127.0.0.1: to expose on the host network (e.g. for remote clients).
|
|
- "127.0.0.1:8642:8642"
|
|
volumes:
|
|
# Persist config, state, sessions, skills, memory across restarts
|
|
- hermes-home:/home/hermes/.hermes
|
|
# Expose agent source so the WebUI can install dependencies from it
|
|
- hermes-agent-src:/opt/hermes
|
|
environment:
|
|
- HERMES_HOME=/home/hermes/.hermes
|
|
# Align UID/GID across containers sharing the hermes-home volume.
|
|
# Defaults to 1000 to match WANTED_UID/WANTED_GID in the webui service.
|
|
# The agent image's entrypoint already supports usermod remapping.
|
|
- HERMES_UID=${UID:-1000}
|
|
- HERMES_GID=${GID:-1000}
|
|
# Bind-mount permission handling for the agent — narrow set of overrides.
|
|
# NOTE: The agent's HERMES_HOME_MODE applies to the HERMES_HOME *directory*
|
|
# mode (default 0700) — NOT to credential files like the WebUI's variant.
|
|
# If you set this, you MUST keep the owner-execute bit so the agent can
|
|
# traverse its own home directory. 0640 BREAKS the agent (no x bit → no
|
|
# traversal). Use 0750 for group-traversable or 0701 for x-only.
|
|
# The agent's container detection (/.dockerenv) already auto-skips
|
|
# credential chmod inside Docker, so HERMES_SKIP_CHMOD is redundant here.
|
|
# - HERMES_HOME_MODE=0750
|
|
restart: unless-stopped
|
|
networks:
|
|
- hermes-net
|
|
|
|
hermes-webui:
|
|
image: ghcr.io/nesquena/hermes-webui:latest
|
|
container_name: hermes-webui
|
|
depends_on:
|
|
- hermes-agent
|
|
ports:
|
|
- "127.0.0.1:8787:8787"
|
|
volumes:
|
|
# Same hermes home as the agent — shares config, sessions, state
|
|
- hermes-home:/home/hermeswebui/.hermes
|
|
# Agent source mounted where docker_init.bash expects it.
|
|
# At startup the init script runs:
|
|
# uv pip install /home/hermeswebui/.hermes/hermes-agent
|
|
# which installs the agent and all its Python dependencies.
|
|
- hermes-agent-src:/home/hermeswebui/.hermes/hermes-agent
|
|
# Workspace directory — browse and edit files from the WebUI.
|
|
# Adapt the host path to your project directory.
|
|
# Override with: HERMES_WORKSPACE=/your/path docker compose up
|
|
- ${HERMES_WORKSPACE:-~/workspace}:/workspace
|
|
environment:
|
|
- HERMES_WEBUI_HOST=0.0.0.0
|
|
- HERMES_WEBUI_PORT=8787
|
|
- HERMES_WEBUI_STATE_DIR=/home/hermeswebui/.hermes/webui
|
|
# Match your host user's UID/GID for correct file permissions.
|
|
# In two-container setups the WebUI auto-detects UID/GID from the shared
|
|
# hermes-home volume, but you can override explicitly if needed (#668):
|
|
# Run `id -u` and `id -g` to find your values.
|
|
# On macOS, UIDs start at 501 — set these in a .env file:
|
|
# echo "UID=$(id -u)" >> .env && echo "GID=$(id -g)" >> .env
|
|
- WANTED_UID=${UID:-1000}
|
|
- WANTED_GID=${GID:-1000}
|
|
# Optional: set a password for remote access
|
|
# - HERMES_WEBUI_PASSWORD=your-secret-password
|
|
# Bind-mount permission handling for the WebUI (fixes #1389, #1399).
|
|
# NOTE: WebUI's HERMES_HOME_MODE is a credential-file threshold (allow
|
|
# group bits on .env/.signing_key/etc.), DIFFERENT from the agent's
|
|
# which applies to the HERMES_HOME directory itself. 0640 is correct
|
|
# for the WebUI; do NOT copy this value to the agent service block.
|
|
# - HERMES_SKIP_CHMOD=1
|
|
# - HERMES_HOME_MODE=0640
|
|
restart: unless-stopped
|
|
networks:
|
|
- hermes-net
|
|
|
|
networks:
|
|
hermes-net:
|
|
driver: bridge
|
|
|
|
volumes:
|
|
hermes-home:
|
|
hermes-agent-src:
|