mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-30 06:41:51 +00:00
ec7736f8a7
When users bind-mount /var/run/docker.sock to use TERMINAL_ENV=docker from inside the container, the supervised hermes user (UID 10000) lacks permission to talk to the socket — every `docker` invocation EACCES'es and check_terminal_requirements() returns False. In messaging mode this also silently strips the file/terminal toolset from the registered tool list, so the agent rationalizes the missing tools as a platform restriction. The naive workaround (docker run --group-add <socket-gid>) does NOT work with our s6-setuidgid privilege drop: s6-setuidgid calls initgroups() for the target user, which rebuilds supp groups from /etc/group. Without a matching /etc/group entry the kernel-granted supp group is wiped between PID 1 and the dropped hermes process. Verified empirically: --group-add 998 alone: PID 1 Groups: 0 998 → after drop: Groups: 10000 This fix's /etc/group add: id hermes shows 998 → after drop: Groups: 998 10000 Detect the socket's GID at boot in stage2-hook (runs as root before the privilege drop), reuse an existing group name if one matches the GID, otherwise create 'hostdocker'. Idempotent across container restarts. Silent no-op when no socket is mounted. End-to-end verified by building the image and running the supervised hermes user against the real host Docker daemon: `docker version` succeeds and check_terminal_requirements() returns True. Fixes #16703
299 lines
15 KiB
Bash
Executable file
299 lines
15 KiB
Bash
Executable file
#!/bin/sh
|
|
# s6-overlay stage2 hook — runs as root after the supervision tree is
|
|
# up but before user services start. Handles UID/GID remap, volume
|
|
# chown, config seeding, and skills sync.
|
|
#
|
|
# Per-service privilege drop happens inside each service's `run` script
|
|
# (and in main-wrapper.sh) via s6-setuidgid, not here.
|
|
#
|
|
# Wired into the image as /etc/cont-init.d/01-hermes-setup by the
|
|
# Dockerfile. The shim at docker/entrypoint.sh forwards to this script
|
|
# so external references to docker/entrypoint.sh still work.
|
|
#
|
|
# NB: cont-init.d scripts run with no arguments — the user's CMD args
|
|
# are NOT visible here. That's fine: we use Architecture B (s6-overlay
|
|
# main-program model), so main-wrapper.sh runs the CMD with full
|
|
# stdin/stdout/stderr access and handles arg parsing there.
|
|
|
|
set -eu
|
|
|
|
HERMES_HOME="${HERMES_HOME:-/opt/data}"
|
|
INSTALL_DIR="/opt/hermes"
|
|
|
|
# --- Bootstrap HERMES_HOME as root ---
|
|
# Create the directory (and any missing parents) while we still have root
|
|
# privileges so the chown checks below see real metadata and the later
|
|
# `s6-setuidgid hermes mkdir -p` block doesn't EACCES on root-owned
|
|
# ancestors. Without this, custom HERMES_HOME paths whose parents only
|
|
# root can create (e.g. `HERMES_HOME=/home/hermes/.hermes` in a Compose
|
|
# file, or any path under a fresh / not pre-populated by the image)
|
|
# fail on first boot with `mkdir: cannot create directory '/...': Permission
|
|
# denied` and the cont-init hook exits non-zero. Idempotent — `mkdir -p`
|
|
# is a no-op if the dir already exists. (#18482, salvages #18488)
|
|
mkdir -p "$HERMES_HOME"
|
|
|
|
# --- UID/GID remap ---
|
|
# Accept PUID/PGID as aliases for HERMES_UID/HERMES_GID. NAS users (UGOS,
|
|
# Synology, unRAID) expect the LinuxServer.io PUID/PGID convention and
|
|
# bind-mount /opt/data from a host directory owned by their own UID; without
|
|
# this alias those vars are silently ignored and the s6-setuidgid drop to
|
|
# UID 10000 leaves the runtime unable to read the volume. HERMES_UID/
|
|
# HERMES_GID still win when both are set. See #15290, salvages #25872.
|
|
HERMES_UID="${HERMES_UID:-${PUID:-}}"
|
|
HERMES_GID="${HERMES_GID:-${PGID:-}}"
|
|
|
|
if [ -n "${HERMES_UID:-}" ] && [ "$HERMES_UID" != "$(id -u hermes)" ]; then
|
|
echo "[stage2] Changing hermes UID to $HERMES_UID"
|
|
usermod -u "$HERMES_UID" hermes
|
|
fi
|
|
if [ -n "${HERMES_GID:-}" ] && [ "$HERMES_GID" != "$(id -g hermes)" ]; then
|
|
echo "[stage2] Changing hermes GID to $HERMES_GID"
|
|
# -o allows non-unique GID (e.g. macOS GID 20 "staff" may already
|
|
# exist as "dialout" in the Debian-based container image).
|
|
groupmod -o -g "$HERMES_GID" hermes 2>/dev/null || true
|
|
fi
|
|
|
|
# --- Docker socket group membership (docker-in-docker / DooD) ---
|
|
# When the user bind-mounts the host Docker daemon socket
|
|
# (`-v /var/run/docker.sock:/var/run/docker.sock`) to use the `docker`
|
|
# terminal backend from inside the container, the socket is owned by the
|
|
# host's `docker` group (or root). The supervised hermes user (UID 10000)
|
|
# is not a member of any group that matches the socket's GID, so every
|
|
# `docker` invocation EACCES'es and `check_terminal_requirements()` fails.
|
|
# See #16703.
|
|
#
|
|
# Granting the supp group via `docker run --group-add <gid>` alone is
|
|
# NOT sufficient with our s6-setuidgid privilege drop: s6-setuidgid (and
|
|
# gosu, the older shim) calls initgroups() for the target user, which
|
|
# rebuilds the supplementary group list from /etc/group. Without an
|
|
# /etc/group entry whose GID matches the socket, the kernel-granted
|
|
# supp group is silently wiped between PID 1 and the dropped process.
|
|
# Confirmed empirically: `--group-add 998` alone leaves the dropped
|
|
# hermes process with `Groups: 10000` (998 gone); after this hook adds
|
|
# the entry, the dropped process has `Groups: 998 10000` as expected.
|
|
#
|
|
# Fix: detect the socket's GID at boot and ensure /etc/group has a
|
|
# matching entry that includes hermes. Idempotent across container
|
|
# restarts. Skipped silently when no socket is bind-mounted.
|
|
#
|
|
# Handles the awkward corner cases:
|
|
# - socket owned by GID 0 (root) — some Podman setups; usermod -aG root
|
|
# - socket GID already used by a known container group (e.g. tty=5):
|
|
# reuse that group's name rather than creating a duplicate
|
|
# - hermes is already a member of the right group (idempotent restart)
|
|
# - chown/groupadd failures under rootless containers — non-fatal
|
|
for sock in /var/run/docker.sock /run/docker.sock; do
|
|
[ -S "$sock" ] || continue
|
|
sock_gid=$(stat -c '%g' "$sock" 2>/dev/null) || continue
|
|
[ -n "$sock_gid" ] || continue
|
|
# Already a member? Nothing to do.
|
|
if id -G hermes 2>/dev/null | tr ' ' '\n' | grep -qx "$sock_gid"; then
|
|
echo "[stage2] hermes already in group $sock_gid for $sock"
|
|
break
|
|
fi
|
|
# Resolve or create a group name for this GID.
|
|
sock_group=$(getent group "$sock_gid" 2>/dev/null | cut -d: -f1)
|
|
if [ -z "$sock_group" ]; then
|
|
sock_group="hostdocker"
|
|
if ! groupadd -g "$sock_gid" "$sock_group" 2>/dev/null; then
|
|
echo "[stage2] Warning: groupadd -g $sock_gid $sock_group failed; skipping docker socket group setup"
|
|
break
|
|
fi
|
|
echo "[stage2] Created group $sock_group (GID $sock_gid) for Docker socket"
|
|
fi
|
|
if usermod -aG "$sock_group" hermes 2>/dev/null; then
|
|
echo "[stage2] Added hermes to group $sock_group (GID $sock_gid) for $sock"
|
|
else
|
|
echo "[stage2] Warning: usermod -aG $sock_group hermes failed; docker backend may fail with EACCES"
|
|
fi
|
|
break
|
|
done
|
|
|
|
# --- Fix ownership of data volume ---
|
|
# When HERMES_UID is remapped or the top-level $HERMES_HOME isn't owned by
|
|
# the runtime hermes UID, restore ownership to hermes — but ONLY for the
|
|
# directories hermes actually writes to. The full $HERMES_HOME may be a
|
|
# host-mounted bind containing unrelated user files; `chown -R` would
|
|
# silently destroy host ownership of those (see issue #19788).
|
|
#
|
|
# The canonical list of hermes-owned subdirs is the same one the s6-setuidgid
|
|
# mkdir -p block below seeds. Keep them in sync if the seed list changes.
|
|
actual_hermes_uid=$(id -u hermes)
|
|
needs_chown=false
|
|
if [ -n "${HERMES_UID:-}" ] && [ "$HERMES_UID" != "10000" ]; then
|
|
needs_chown=true
|
|
elif [ "$(stat -c %u "$HERMES_HOME" 2>/dev/null)" != "$actual_hermes_uid" ]; then
|
|
needs_chown=true
|
|
fi
|
|
if [ "$needs_chown" = true ]; then
|
|
echo "[stage2] Fixing ownership of $HERMES_HOME (targeted) to hermes ($actual_hermes_uid)"
|
|
# In rootless Podman the container's "root" is mapped to an
|
|
# unprivileged host UID — chown will fail. That's fine: the volume
|
|
# is already owned by the mapped user on the host side.
|
|
#
|
|
# Top-level $HERMES_HOME: chown the directory itself (not its contents)
|
|
# so hermes can mkdir new subdirs but bind-mounted host files keep
|
|
# their existing ownership.
|
|
chown hermes:hermes "$HERMES_HOME" 2>/dev/null || \
|
|
echo "[stage2] Warning: chown $HERMES_HOME failed (rootless container?) — continuing"
|
|
# Hermes-owned subdirs: recursive chown is safe here because these are
|
|
# created and managed exclusively by hermes (see the s6-setuidgid mkdir
|
|
# -p block below for the canonical list).
|
|
for sub in cron sessions logs hooks memories skills skins plans workspace home profiles; do
|
|
if [ -e "$HERMES_HOME/$sub" ]; then
|
|
chown -R hermes:hermes "$HERMES_HOME/$sub" 2>/dev/null || \
|
|
echo "[stage2] Warning: chown $HERMES_HOME/$sub failed (rootless container?) — continuing"
|
|
fi
|
|
done
|
|
# Hermes-owned trees under $INSTALL_DIR must be re-chowned when the UID
|
|
# is remapped — otherwise:
|
|
# - .venv: lazy_deps.py cannot install platform packages (discord.py,
|
|
# telegram, slack, etc.) with EACCES (#15012, #21100)
|
|
# - ui-tui: esbuild rebuilds dist/entry.js on every TUI launch (when
|
|
# the source mtime is newer than dist/ or when HERMES_TUI_FORCE_BUILD
|
|
# is set) and writes to ui-tui/dist/. Without this chown the new
|
|
# hermes UID can't write the build output (#28851).
|
|
# - node_modules: root-level dependencies (puppeteer, web tooling)
|
|
# that runtime code may walk/update.
|
|
# The set mirrors the build-time `chown -R hermes:hermes` line in the
|
|
# Dockerfile — keep them in sync if the Dockerfile chown set changes.
|
|
# These are under $INSTALL_DIR (not $HERMES_HOME), so the bind-mount
|
|
# concern doesn't apply — recursive is fine.
|
|
chown -R hermes:hermes \
|
|
"$INSTALL_DIR/.venv" \
|
|
"$INSTALL_DIR/ui-tui" \
|
|
"$INSTALL_DIR/node_modules" \
|
|
2>/dev/null || \
|
|
echo "[stage2] Warning: chown of build trees failed (rootless container?) — continuing"
|
|
fi
|
|
|
|
# Always reset ownership of $HERMES_HOME/profiles to hermes on every
|
|
# boot. Profile dirs and files can land owned by root when commands
|
|
# are invoked via `docker exec <container> hermes …` (which defaults
|
|
# to root unless `-u` is passed), and that breaks the cont-init
|
|
# reconciler (02-reconcile-profiles) which runs as hermes and walks
|
|
# the profiles dir. Idempotent; skipped on rootless containers where
|
|
# chown would fail.
|
|
if [ -d "$HERMES_HOME/profiles" ]; then
|
|
chown -R hermes:hermes "$HERMES_HOME/profiles" 2>/dev/null || true
|
|
fi
|
|
|
|
# --- config.yaml permissions ---
|
|
# Ensure config.yaml is readable by the hermes runtime user even if it
|
|
# was edited on the host after initial ownership setup.
|
|
if [ -f "$HERMES_HOME/config.yaml" ]; then
|
|
chown hermes:hermes "$HERMES_HOME/config.yaml" 2>/dev/null || true
|
|
chmod 640 "$HERMES_HOME/config.yaml" 2>/dev/null || true
|
|
fi
|
|
|
|
# --- Seed directory structure as hermes user ---
|
|
# Run as hermes via s6-setuidgid so dirs end up owned correctly (matters
|
|
# under rootless Podman where chown back to root would fail).
|
|
#
|
|
# Use direct `mkdir -p` invocation (no `sh -c "..."` wrapper) so the
|
|
# shell isn't a second interpreter — defends against $HERMES_HOME values
|
|
# containing shell metacharacters. PR #30136 review item O2.
|
|
s6-setuidgid hermes mkdir -p \
|
|
"$HERMES_HOME/cron" \
|
|
"$HERMES_HOME/sessions" \
|
|
"$HERMES_HOME/logs" \
|
|
"$HERMES_HOME/hooks" \
|
|
"$HERMES_HOME/memories" \
|
|
"$HERMES_HOME/skills" \
|
|
"$HERMES_HOME/skins" \
|
|
"$HERMES_HOME/plans" \
|
|
"$HERMES_HOME/workspace" \
|
|
"$HERMES_HOME/home"
|
|
|
|
# --- Install-method stamp (read by detect_install_method() in hermes status) ---
|
|
# Preserved from the tini-era entrypoint (PR #27843). Must be written as
|
|
# the hermes user so ownership matches the file's documented owner.
|
|
# tee is invoked directly via s6-setuidgid (no `sh -c` wrapper) for the
|
|
# same shell-metacharacter safety described above.
|
|
printf 'docker\n' | s6-setuidgid hermes tee "$HERMES_HOME/.install_method" >/dev/null \
|
|
|| true
|
|
|
|
# --- Seed config files (only on first boot) ---
|
|
seed_one() {
|
|
dest=$1
|
|
src=$2
|
|
if [ ! -f "$HERMES_HOME/$dest" ] && [ -f "$INSTALL_DIR/$src" ]; then
|
|
s6-setuidgid hermes cp "$INSTALL_DIR/$src" "$HERMES_HOME/$dest"
|
|
fi
|
|
}
|
|
seed_one ".env" ".env.example"
|
|
seed_one "config.yaml" "cli-config.yaml.example"
|
|
seed_one "SOUL.md" "docker/SOUL.md"
|
|
|
|
# .env holds API keys and secrets — restrict to owner-only access. Applied
|
|
# unconditionally (not only on first-seed) so a host-mounted .env that was
|
|
# created with a permissive umask gets tightened on every container start.
|
|
if [ -f "$HERMES_HOME/.env" ]; then
|
|
chown hermes:hermes "$HERMES_HOME/.env" 2>/dev/null || true
|
|
chmod 600 "$HERMES_HOME/.env" 2>/dev/null || true
|
|
fi
|
|
|
|
# auth.json: bootstrap from env on first boot only. Same semantics as the
|
|
# pre-s6 entrypoint — the [ ! -f ] guard is critical to avoid clobbering
|
|
# rotated refresh tokens on container restart.
|
|
if [ ! -f "$HERMES_HOME/auth.json" ] && [ -n "${HERMES_AUTH_JSON_BOOTSTRAP:-}" ]; then
|
|
printf '%s' "$HERMES_AUTH_JSON_BOOTSTRAP" > "$HERMES_HOME/auth.json"
|
|
chown hermes:hermes "$HERMES_HOME/auth.json" 2>/dev/null || true
|
|
chmod 600 "$HERMES_HOME/auth.json"
|
|
fi
|
|
|
|
# --- Sync bundled skills ---
|
|
# Invoke the venv's python by absolute path so we don't need a `sh -c`
|
|
# wrapper to source the activate script. This is safe because
|
|
# skills_sync.py doesn't depend on any environment exports beyond what
|
|
# the python binary's own bin-stub already sets up (sys.path is rooted
|
|
# at the venv's site-packages by virtue of running .venv/bin/python).
|
|
if [ -d "$INSTALL_DIR/skills" ]; then
|
|
s6-setuidgid hermes "$INSTALL_DIR/.venv/bin/python" "$INSTALL_DIR/tools/skills_sync.py" \
|
|
|| echo "[stage2] Warning: skills_sync.py failed; continuing"
|
|
fi
|
|
|
|
# --- Discover agent-browser's Chromium binary ---
|
|
# The image's Dockerfile runs `npx playwright install chromium`, which
|
|
# populates ``$PLAYWRIGHT_BROWSERS_PATH`` (=/opt/hermes/.playwright) with
|
|
# a ``chromium_headless_shell-<build>/chrome-headless-shell-linux64/``
|
|
# directory. agent-browser (the runtime CLI Hermes spawns for the
|
|
# browser tool) doesn't recognise this layout in its own cache scan and
|
|
# fails with "Auto-launch failed: Chrome not found" — even though the
|
|
# binary is right there (#15697).
|
|
#
|
|
# Fix: locate the binary at boot and export ``AGENT_BROWSER_EXECUTABLE_PATH``
|
|
# via /run/s6/container_environment so the `with-contenv` shebang on
|
|
# main-wrapper.sh propagates it into the supervised ``hermes`` process
|
|
# and thence to agent-browser subprocesses.
|
|
#
|
|
# - Skipped when the user has already set ``AGENT_BROWSER_EXECUTABLE_PATH``
|
|
# (lets users override with a system Chrome install).
|
|
# - Filename-matched (not path-matched): the chromium dir contains many
|
|
# shared libraries (libGLESv2.so, libEGL.so, ...) which inherit the
|
|
# executable bit from Playwright's tarball but are NOT browser binaries.
|
|
# We only accept files whose basename is chrome / chromium /
|
|
# chrome-headless-shell / chromium-browser. Compare PR #18635's earlier
|
|
# ``find | grep -Ei 'chrome|chromium'`` which would match the path
|
|
# ``.../chrome-headless-shell-linux64/libGLESv2.so`` and pick a .so.
|
|
# - Quietly skipped when $PLAYWRIGHT_BROWSERS_PATH doesn't exist (e.g.
|
|
# custom builds that strip Playwright).
|
|
if [ -z "${AGENT_BROWSER_EXECUTABLE_PATH:-}" ] && \
|
|
[ -n "${PLAYWRIGHT_BROWSERS_PATH:-}" ] && \
|
|
[ -d "$PLAYWRIGHT_BROWSERS_PATH" ]; then
|
|
browser_bin=$(find "$PLAYWRIGHT_BROWSERS_PATH" -type f -executable \
|
|
\( -name 'chrome' -o -name 'chromium' \
|
|
-o -name 'chrome-headless-shell' -o -name 'chromium-browser' \) \
|
|
2>/dev/null | head -n 1)
|
|
if [ -n "$browser_bin" ]; then
|
|
echo "[stage2] Found agent-browser Chromium binary: $browser_bin"
|
|
# Write to s6's container_environment so with-contenv picks it
|
|
# up for all supervised services (main-hermes, dashboard, etc.).
|
|
# Idempotent: each boot overwrites with the current path.
|
|
printf '%s' "$browser_bin" > /run/s6/container_environment/AGENT_BROWSER_EXECUTABLE_PATH
|
|
else
|
|
echo "[stage2] Warning: no Chromium binary under $PLAYWRIGHT_BROWSERS_PATH; browser tool may fail"
|
|
fi
|
|
fi
|
|
|
|
echo "[stage2] Setup complete; starting user services"
|