Something went wrong. Try again.
Hermes WebUI: The best way to use Hermes Agent from the web or from your phone!
Something went wrong. Try again.
hermes-webui docker_init.bash
15 kB · 330 lines
at master
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331#!/bin/bash
set -e
error_exit() { echo -n "!! ERROR: " echo $* echo "!! Exiting script (ID: $$)" exit 1}
ok_exit() { echo $* echo "++ Exiting script (ID: $$)" exit 0}
## Environment variables loaded when passing environment variables from user to user# Ignore list: variables to ignore when loading environment variables from user to userexport ENV_IGNORELIST="HOME PWD USER SHLVL TERM OLDPWD SHELL _ SUDO_COMMAND HOSTNAME LOGNAME MAIL SUDO_GID SUDO_UID SUDO_USER CHECK_NV_CUDNN_VERSION VIRTUAL_ENV VIRTUAL_ENV_PROMPT ENV_IGNORELIST ENV_OBFUSCATE_PART"# Obfuscate part: part of the key to obfuscate when loading environment variables from user to user, ex: HF_TOKEN, ...export ENV_OBFUSCATE_PART="TOKEN API KEY"
# Check for ENV_IGNORELIST and ENV_OBFUSCATE_PARTif [ -z "${ENV_IGNORELIST+x}" ]; then error_exit "ENV_IGNORELIST not set"; fiif [ -z "${ENV_OBFUSCATE_PART+x}" ]; then error_exit "ENV_OBFUSCATE_PART not set"; fi
whoami=`whoami`script_dir=$(dirname $0)script_name=$(basename $0)echo ""; echo ""echo "======================================"echo "=================== Starting script (ID: $$)"echo "== Running ${script_name} in ${script_dir} as ${whoami}"script_fullname=$0echo " - script_fullname: ${script_fullname}"ignore_value="VALUE_TO_IGNORE"
# everyone can read our files by defaultumask 0022
# Write a world-writeable file (preferably inside /tmp -- ie within the container)write_worldtmpfile() { tmpfile=$1 if [ -z "${tmpfile}" ]; then error_exit "write_worldfile: missing argument"; fi if [ -f $tmpfile ]; then rm -f $tmpfile; fi echo -n $2 > ${tmpfile} chmod 777 ${tmpfile}}
itdir=/tmp/hermeswebui_initif [ ! -d $itdir ]; then mkdir $itdir; chmod 777 $itdir; fiif [ ! -d $itdir ]; then error_exit "Failed to create $itdir"; fi
# Set user and group id# logic: if not set and file exists, use file value, else use default. Create file for persistence when the container is re-run# reasoning: needed when using docker compose as the file will exist in the stopped container, and changing the value from environment variables or configuration file must be propagated from hermeswebuitoo to hermeswebuitoo transition (those values are the only ones loaded before the environment variables dump file are loaded)it=$itdir/hermeswebui_user_uidif [ -z "${WANTED_UID+x}" ]; then if [ -f $it ]; then WANTED_UID=$(cat $it); fifi# Auto-detect from mounted volumes if still unset (#569, #668).# On macOS, host UIDs start at 501. Using the wrong UID means the container# user cannot read the bind-mounted files, making the workspace appear empty.# In two-container setups (hermes-agent + hermes-webui), the shared hermes-home# volume may be owned by the agent container's UID — detect from there first.if [ -z "${WANTED_UID+x}" ] || [ "${WANTED_UID}" = "1024" ]; then # Priority 1: hermes-home shared volume — covers two-container Zeabur/Compose setups (#668) for _probe_dir in "/home/hermeswebui/.hermes" "$HERMES_HOME" "/opt/data"; do if [ -d "$_probe_dir" ]; then _detected_uid=$(stat -c '%u' "$_probe_dir" 2>/dev/null || echo "") if [ -n "$_detected_uid" ] && [ "$_detected_uid" != "0" ]; then echo "-- Auto-detected UID: $_detected_uid (from $_probe_dir)" WANTED_UID=$_detected_uid break fi fi donefiif [ -z "${WANTED_UID+x}" ] || [ "${WANTED_UID}" = "1024" ]; then # Priority 2: /workspace bind-mount — the standard single-container mount point if [ -d "/workspace" ]; then _detected_uid=$(stat -c '%u' "/workspace" 2>/dev/null || echo "") if [ -n "$_detected_uid" ] && [ "$_detected_uid" != "0" ]; then echo "-- Auto-detected workspace UID: $_detected_uid (from /workspace)" WANTED_UID=$_detected_uid fi fifiWANTED_UID=${WANTED_UID:-1024}write_worldtmpfile $it "$WANTED_UID"echo "-- WANTED_UID: \"${WANTED_UID}\""
it=$itdir/hermeswebui_user_gidif [ -z "${WANTED_GID+x}" ]; then if [ -f $it ]; then WANTED_GID=$(cat $it); fifi# Auto-detect GID from mounted volumes to match (#569, #668)if [ -z "${WANTED_GID+x}" ] || [ "${WANTED_GID}" = "1024" ]; then # Priority 1: hermes-home shared volume for _probe_dir in "/home/hermeswebui/.hermes" "$HERMES_HOME" "/opt/data"; do if [ -d "$_probe_dir" ]; then _detected_gid=$(stat -c '%g' "$_probe_dir" 2>/dev/null || echo "") if [ -n "$_detected_gid" ] && [ "$_detected_gid" != "0" ]; then echo "-- Auto-detected GID: $_detected_gid (from $_probe_dir)" WANTED_GID=$_detected_gid break fi fi donefiif [ -z "${WANTED_GID+x}" ] || [ "${WANTED_GID}" = "1024" ]; then # Priority 2: /workspace bind-mount if [ -d "/workspace" ]; then _detected_gid=$(stat -c '%g' "/workspace" 2>/dev/null || echo "") if [ -n "$_detected_gid" ] && [ "$_detected_gid" != "0" ]; then echo "-- Auto-detected workspace GID: $_detected_gid (from /workspace)" WANTED_GID=$_detected_gid fi fifiWANTED_GID=${WANTED_GID:-1024}write_worldtmpfile $it "$WANTED_GID"echo "-- WANTED_GID: \"${WANTED_GID}\""
echo "== Most Environment variables set"
# Check user id and group idnew_gid=`id -g`new_uid=`id -u`echo "== user ($whoami)"echo " uid: $new_uid / WANTED_UID: $WANTED_UID"echo " gid: $new_gid / WANTED_GID: $WANTED_GID"
save_env() { tosave=$1 echo "-- Saving environment variables to $tosave" env | sort > "$tosave"}
load_env() { tocheck=$1 overwrite_if_different=$2 ignore_list="${ENV_IGNORELIST}" obfuscate_part="${ENV_OBFUSCATE_PART}" if [ -f "$tocheck" ]; then echo "-- Loading environment variables from $tocheck (overwrite existing: $overwrite_if_different) (ignorelist: $ignore_list) (obfuscate: $obfuscate_part)" while IFS='=' read -r key value; do doit=false # checking if the key is in the ignorelist for i in $ignore_list; do if [[ "A$key" == "A$i" ]]; then doit=ignore; break; fi done if [[ "A$doit" == "Aignore" ]]; then continue; fi rvalue=$value # checking if part of the key is in the obfuscate list doobs=false for i in $obfuscate_part; do if [[ "A$key" == *"$i"* ]]; then doobs=obfuscate; break; fi done if [[ "A$doobs" == "Aobfuscate" ]]; then rvalue="**OBFUSCATED**"; fi
if [ -z "${!key}" ]; then echo " ++ Setting environment variable $key [$rvalue]" doit=true elif [ "A$overwrite_if_different" == "Atrue" ]; then cvalue="${!key}" if [[ "A${doobs}" == "Aobfuscate" ]]; then cvalue="**OBFUSCATED**"; fi if [[ "A${!key}" != "A${value}" ]]; then echo " @@ Overwriting environment variable $key [$cvalue] -> [$rvalue]" doit=true else echo " == Environment variable $key [$rvalue] already set and value is unchanged" fi fi if [[ "A$doit" == "Atrue" ]]; then export "$key=$value" fi done < "$tocheck" fi}
# hermeswebuitoo is a specfiic user not existing by default on ubuntu, we can check its whomaiif [ "A${whoami}" == "Ahermeswebuitoo" ]; then echo "-- Running as hermeswebuitoo, will switch hermeswebui to the desired UID/GID" # The script is started as hermeswebuitoo -- UID/GID 1025/1025
# We are altering the UID/GID of the hermeswebui user to the desired ones and restarting as that user # using usermod for the already create hermeswebui user, knowing it is not already in use # per usermod manual: "You must make certain that the named user is not executing any processes when this command is being executed" sudo groupmod -o -g ${WANTED_GID} hermeswebui || error_exit "Failed to set GID of hermeswebui user" sudo usermod -o -u ${WANTED_UID} hermeswebui || error_exit "Failed to set UID of hermeswebui user" sudo chown -R ${WANTED_UID}:${WANTED_GID} /home/hermeswebui || error_exit "Failed to set owner of /home/hermeswebui" save_env /tmp/hermeswebuitoo_env.txt # restart the script as hermeswebui set with the correct UID/GID this time echo "-- Restarting as hermeswebui user with UID ${WANTED_UID} GID ${WANTED_GID}" sudo su hermeswebui $script_fullname || error_exit "subscript failed" ok_exit "Clean exit"fi
# If we are here, the script is started as another user than hermeswebuitoo# because the whoami value for the hermeswebui user can be any existing user, we can not check against it# instead we check if the UID/GID are the expected onesif [ "$WANTED_GID" != "$new_gid" ]; then error_exit "hermeswebui MUST be running as UID ${WANTED_UID} GID ${WANTED_GID}, current UID ${new_uid} GID ${new_gid}"; fiif [ "$WANTED_UID" != "$new_uid" ]; then error_exit "hermeswebui MUST be running as UID ${WANTED_UID} GID ${WANTED_GID}, current UID ${new_uid} GID ${new_gid}"; fi
########## 'hermeswebui' specific section below
# We are therefore running as hermeswebuiecho ""; echo "== Running as hermeswebui"
# Load environment variables one by one if they do not exist from /tmp/hermeswebuitoo_env.txtit=/tmp/hermeswebuitoo_env.txtif [ -f $it ]; then echo "-- Loading not already set environment variables from $it" load_env $it truefi
##echo ""; echo "-- Making sure /app is owned by the hermeswebui user to avoid permission issues when running the server "sudo mkdir -p /app || error_exit "Failed to create /app directory"sudo chown hermeswebui:hermeswebui /app || error_exit "Failed to set owner of /app to hermeswebui user"sudo rsync -av --chown=hermeswebui:hermeswebui /apptoo/ /app/ || error_exit "Failed to sync /apptoo to /app with correct ownership"it=/app/.testfile; touch $it || error_exit "Failed to verify /app directory"rm -f $it || error_exit "Failed to delete test file in /app"
######## Environment variables (consume AFTER the load_env)
echo ""; echo "== Checking required environment variables for hermes-webui"
echo ""; echo "-- HERMES_WEBUI_VERSION: Where to store sessions, workspaces, and other state (default: ~/.hermes/webui-mvp)"if [ -z "${HERMES_WEBUI_STATE_DIR+x}" ]; then error_exit "HERMES_WEBUI_STATE_DIR not set"; fi; echo "-- HERMES_WEBUI_STATE_DIR: $HERMES_WEBUI_STATE_DIR"if [ ! -d "$HERMES_WEBUI_STATE_DIR" ]; then mkdir -p $HERMES_WEBUI_STATE_DIR || error_exit "Failed to create state directory at $HERMES_WEBUI_STATE_DIR"; fiif [ ! -d "$HERMES_WEBUI_STATE_DIR" ]; then error_exit "HERMES_WEBUI_STATE_DIR directory does not exist at $HERMES_WEBUI_STATE_DIR"; fiit="$HERMES_WEBUI_STATE_DIR/.testfile"; touch $it || error_exit "Failed to verify state directory at $HERMES_WEBUI_STATE_DIR"rm -f $it || error_exit "Failed to delete test file in $HERMES_WEBUI_STATE_DIR"
echo ""; echo "-- HERMES_WEBUI_DEFAULT_WORKSPACE: Default workspace directory shown on first launch"if [ -z "${HERMES_WEBUI_DEFAULT_WORKSPACE+x}" ]; then echo "HERMES_WEBUI_DEFAULT_WORKSPACE not set, setting to /workspace"; export HERMES_WEBUI_DEFAULT_WORKSPACE="/workspace"; fi;echo "-- HERMES_WEBUI_DEFAULT_WORKSPACE: $HERMES_WEBUI_DEFAULT_WORKSPACE"# Use sudo for mkdir — Docker may auto-create bind-mount directories as root (#357).# Skip mkdir if the directory already exists (e.g. a read-only mount — #670).if [ ! -d "$HERMES_WEBUI_DEFAULT_WORKSPACE" ]; then sudo mkdir -p "$HERMES_WEBUI_DEFAULT_WORKSPACE" || error_exit "Failed to create default workspace at $HERMES_WEBUI_DEFAULT_WORKSPACE"fiif [ ! -d "$HERMES_WEBUI_DEFAULT_WORKSPACE" ]; then error_exit "HERMES_WEBUI_DEFAULT_WORKSPACE directory does not exist at $HERMES_WEBUI_DEFAULT_WORKSPACE"; fi# Only chown and write-test if the workspace is writable. Read-only bind-mounts# (:ro) are valid — the workspace is used for browsing, not writing by the server.if [ -w "$HERMES_WEBUI_DEFAULT_WORKSPACE" ]; then sudo chown hermeswebui:hermeswebui "$HERMES_WEBUI_DEFAULT_WORKSPACE" || echo "!! WARNING: Could not chown $HERMES_WEBUI_DEFAULT_WORKSPACE (continuing)" it="$HERMES_WEBUI_DEFAULT_WORKSPACE/.testfile"; touch $it && rm -f $it || echo "!! WARNING: Could not write to $HERMES_WEBUI_DEFAULT_WORKSPACE (continuing)"else echo "-- HERMES_WEBUI_DEFAULT_WORKSPACE is read-only — skipping chown/write check (read-only workspace is supported)"fi
echo ""; echo "==================="echo ""; echo "== Installing uv and creating a new virtual environment for hermes-webui"
export PATH="/home/hermeswebui/.local/bin/:$PATH"if command -v uv &>/dev/null; then echo "-- uv already installed ($(uv --version)), skipping download"else echo "-- uv not found, downloading..." curl -LsSf https://astral.sh/uv/install.sh | sh || error_exit "Failed to install uv — check network connectivity"fiexport UV_PROJECT_ENVIRONMENT=venv
export UV_CACHE_DIR=/uv_cachesudo mkdir -p ${UV_CACHE_DIR} || error_exit "Failed to create /uv_cache directory"sudo chown hermeswebui:hermeswebui ${UV_CACHE_DIR} || error_exit "Failed to set owner of ${UV_CACHE_DIR} to hermeswebui user"
cd /appif [ -f /app/venv/bin/python3 ]; then echo ""; echo "== Existing virtual environment found — reusing (fast restart)"else echo ""; echo "== Creating new virtual environment" uv venv venvfiexport VIRTUAL_ENV=/app/venvtest -d /app/venvtest -f /app/venv/bin/activate
echo "";echo "== Activating hermes webui's virtual environment"source /app/venv/bin/activate || error_exit "Failed to activate hermeswebui virtual environment"test -x /app/venv/bin/python3
if [ -f /app/venv/.deps_installed ]; then echo ""; echo "== Dependencies already installed — skipping (fast restart)"else echo ""; echo "== Installing hermes-webui dependencies" uv pip install -r requirements.txt --trusted-host pypi.org --trusted-host files.pythonhosted.org uv pip install -U pip setuptools --trusted-host pypi.org --trusted-host files.pythonhosted.org test -x /app/venv/bin/pip
echo ""; echo "== Adding hermes-agent's pyproject.toml base dependencies to the virtual environment" _agent_paths=( "/home/hermeswebui/.hermes/hermes-agent" "/opt/hermes" ) _agent_src="" for _p in "${_agent_paths[@]}"; do if [ -d "$_p" ] && [ -f "$_p/pyproject.toml" ]; then _agent_src="$_p" break fi done if [ -n "$_agent_src" ]; then uv pip install "$_agent_src[all]" --trusted-host pypi.org --trusted-host files.pythonhosted.org || error_exit "Failed to install hermes-agent's requirements" else echo "" echo "!! WARNING: hermes-agent source not found." echo "!! Looked in: ${_agent_paths[0]}" echo "!! ${_agent_paths[1]}" echo "!! The WebUI will start with reduced functionality (no model auto-detection," echo "!! no personality routing, no CLI session imports)." echo "!! To fix: mount the agent source volume into the container:" echo "!! -v /path/to/hermes-agent:/home/hermeswebui/.hermes/hermes-agent" echo "!! Or see the two-container compose example:" echo "!! https://github.com/nesquena/hermes-webui/blob/master/docker-compose.two-container.yml" echo "" fi touch /app/venv/.deps_installedfi
echo ""; echo "== Running hermes-webui"cd /app; python server.py || error_exit "hermes-webui failed or exited with an error"
# we should never be here because the server should be running indefinitely, but if we are, we exit safelyok_exit "Clean exit"