1049 lines
43 KiB
Bash
1049 lines
43 KiB
Bash
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
|
|
# Ensure Homebrew and brew-installed binaries are in PATH
|
|
# This is needed for OpenClaw skills that depend on CLI tools (gemini, aider, etc.)
|
|
export PATH="/home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin:${PATH}"
|
|
|
|
# Home Assistant add-on options are usually rendered to /data/options.json
|
|
OPTIONS_FILE="/data/options.json"
|
|
|
|
if [ ! -f "$OPTIONS_FILE" ]; then
|
|
echo "Missing $OPTIONS_FILE (add-on options)."
|
|
exit 1
|
|
fi
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Read add-on options (only add-on-specific knobs; OpenClaw is configured via onboarding)
|
|
# ------------------------------------------------------------------------------
|
|
|
|
TZNAME=$(jq -r '.timezone // "Europe/Sofia"' "$OPTIONS_FILE")
|
|
GW_PUBLIC_URL=$(jq -r '.gateway_public_url // empty' "$OPTIONS_FILE")
|
|
HA_TOKEN=$(jq -r '.homeassistant_token // empty' "$OPTIONS_FILE")
|
|
ADDON_HTTP_PROXY=$(jq -r '.http_proxy // empty' "$OPTIONS_FILE")
|
|
ENABLE_TERMINAL=$(jq -r '.enable_terminal // true' "$OPTIONS_FILE")
|
|
TERMINAL_PORT_RAW=$(jq -r '.terminal_port // 7681' "$OPTIONS_FILE")
|
|
|
|
# SECURITY: Validate TERMINAL_PORT to prevent nginx config injection
|
|
# Only allow numeric values in valid port range (1024-65535)
|
|
if [[ "$TERMINAL_PORT_RAW" =~ ^[0-9]+$ ]] && [ "$TERMINAL_PORT_RAW" -ge 1024 ] && [ "$TERMINAL_PORT_RAW" -le 65535 ]; then
|
|
TERMINAL_PORT="$TERMINAL_PORT_RAW"
|
|
else
|
|
echo "ERROR: Invalid terminal_port '$TERMINAL_PORT_RAW'. Must be numeric 1024-65535. Using default 7681."
|
|
TERMINAL_PORT="7681"
|
|
fi
|
|
|
|
echo "DEBUG: enable_terminal config value: '$ENABLE_TERMINAL'"
|
|
echo "DEBUG: terminal_port config value: '$TERMINAL_PORT' (validated)"
|
|
|
|
# Generic router SSH settings
|
|
ROUTER_HOST=$(jq -r '.router_ssh_host // empty' "$OPTIONS_FILE")
|
|
ROUTER_USER=$(jq -r '.router_ssh_user // empty' "$OPTIONS_FILE")
|
|
ROUTER_KEY=$(jq -r '.router_ssh_key_path // "/data/keys/router_ssh"' "$OPTIONS_FILE")
|
|
|
|
# Optional: allow disabling lock cleanup if you ever need to debug
|
|
CLEAN_LOCKS_ON_START=$(jq -r '.clean_session_locks_on_start // true' "$OPTIONS_FILE")
|
|
CLEAN_LOCKS_ON_EXIT=$(jq -r '.clean_session_locks_on_exit // true' "$OPTIONS_FILE")
|
|
|
|
# Gateway configuration
|
|
GATEWAY_MODE=$(jq -r '.gateway_mode // "local"' "$OPTIONS_FILE")
|
|
GATEWAY_REMOTE_URL=$(jq -r '.gateway_remote_url // empty' "$OPTIONS_FILE")
|
|
GATEWAY_BIND_MODE=$(jq -r '.gateway_bind_mode // "loopback"' "$OPTIONS_FILE")
|
|
GATEWAY_PORT=$(jq -r '.gateway_port // 18789' "$OPTIONS_FILE")
|
|
ENABLE_OPENAI_API=$(jq -r '.enable_openai_api // false' "$OPTIONS_FILE")
|
|
GATEWAY_AUTH_MODE=$(jq -r '.gateway_auth_mode // "token"' "$OPTIONS_FILE")
|
|
GATEWAY_TRUSTED_PROXIES=$(jq -r '.gateway_trusted_proxies // empty' "$OPTIONS_FILE")
|
|
GATEWAY_ADDITIONAL_ALLOWED_ORIGINS=$(jq -r '.gateway_additional_allowed_origins // empty' "$OPTIONS_FILE")
|
|
CONTROLUI_DISABLE_DEVICE_AUTH=$(jq -r '.controlui_disable_device_auth // true' "$OPTIONS_FILE")
|
|
FORCE_IPV4_DNS=$(jq -r '.force_ipv4_dns // true' "$OPTIONS_FILE")
|
|
ACCESS_MODE=$(jq -r '.access_mode // "custom"' "$OPTIONS_FILE")
|
|
NGINX_LOG_LEVEL=$(jq -r '.nginx_log_level // "minimal"' "$OPTIONS_FILE")
|
|
AUTO_CONFIGURE_MCP=$(jq -r '.auto_configure_mcp // false' "$OPTIONS_FILE")
|
|
GW_ENV_VARS_TYPE=$(jq -r 'if .gateway_env_vars == null then "null" else (.gateway_env_vars | type) end' "$OPTIONS_FILE")
|
|
GW_ENV_VARS_RAW=$(jq -r '.gateway_env_vars // empty' "$OPTIONS_FILE")
|
|
GW_ENV_VARS_JSON=$(jq -c '.gateway_env_vars // []' "$OPTIONS_FILE")
|
|
|
|
export TZ="$TZNAME"
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Access mode presets — override individual gateway settings for common scenarios
|
|
# ------------------------------------------------------------------------------
|
|
ENABLE_HTTPS_PROXY=false
|
|
GATEWAY_INTERNAL_PORT="$GATEWAY_PORT"
|
|
|
|
case "$ACCESS_MODE" in
|
|
local_only)
|
|
GATEWAY_BIND_MODE="loopback"
|
|
GATEWAY_AUTH_MODE="token"
|
|
echo "INFO: Access mode: local_only (loopback + token, Ingress/terminal only)"
|
|
;;
|
|
lan_https)
|
|
# Gateway binds loopback on internal port; nginx terminates TLS on the external port.
|
|
GATEWAY_BIND_MODE="loopback"
|
|
GATEWAY_AUTH_MODE="token"
|
|
ENABLE_HTTPS_PROXY=true
|
|
GATEWAY_INTERNAL_PORT=$((GATEWAY_PORT + 1))
|
|
echo "INFO: Access mode: lan_https (built-in HTTPS proxy on 0.0.0.0:${GATEWAY_PORT})"
|
|
;;
|
|
lan_reverse_proxy)
|
|
GATEWAY_BIND_MODE="lan"
|
|
GATEWAY_AUTH_MODE="trusted-proxy"
|
|
if [ -z "$GATEWAY_TRUSTED_PROXIES" ]; then
|
|
echo "ERROR: access_mode=lan_reverse_proxy requires gateway_trusted_proxies to be set."
|
|
echo "ERROR: Set it to your reverse proxy's IP/CIDR (e.g. 127.0.0.1,192.168.88.0/24)."
|
|
fi
|
|
echo "INFO: Access mode: lan_reverse_proxy (LAN bind + trusted-proxy auth)"
|
|
;;
|
|
tailnet_https)
|
|
GATEWAY_BIND_MODE="tailnet"
|
|
GATEWAY_AUTH_MODE="token"
|
|
echo "INFO: Access mode: tailnet_https (Tailscale bind + token auth)"
|
|
;;
|
|
custom|*)
|
|
echo "INFO: Access mode: custom (using individual gateway_bind_mode/auth_mode settings)"
|
|
;;
|
|
esac
|
|
|
|
# Reduce risk of secrets ending up in logs
|
|
set +x
|
|
|
|
# Optional outbound proxy from add-on settings.
|
|
# If set, apply it to both HTTP and HTTPS for Node/undici/OpenClaw tooling.
|
|
if [ -n "$ADDON_HTTP_PROXY" ]; then
|
|
if [[ "$ADDON_HTTP_PROXY" =~ ^https?://[^[:space:]]+$ ]]; then
|
|
# Keep local traffic direct to avoid accidental proxying of loopback/LAN services.
|
|
DEFAULT_NO_PROXY="localhost,127.0.0.1,::1,192.168.0.0/16,10.0.0.0/8,172.16.0.0/12,.local"
|
|
|
|
export HTTP_PROXY="$ADDON_HTTP_PROXY"
|
|
export HTTPS_PROXY="$ADDON_HTTP_PROXY"
|
|
export http_proxy="$ADDON_HTTP_PROXY"
|
|
export https_proxy="$ADDON_HTTP_PROXY"
|
|
export NO_PROXY="${NO_PROXY:+${NO_PROXY},}${DEFAULT_NO_PROXY}"
|
|
export no_proxy="${no_proxy:+${no_proxy},}${DEFAULT_NO_PROXY}"
|
|
echo "INFO: Outbound HTTP/HTTPS proxy enabled from add-on configuration."
|
|
echo "INFO: Applied NO_PROXY defaults for localhost/private network ranges."
|
|
else
|
|
echo "WARN: Invalid http_proxy value in add-on options; expected URL like http://host:port"
|
|
fi
|
|
fi
|
|
|
|
# Optional network hardening/workaround: force IPv4-first DNS ordering for Node.js.
|
|
# Helps in environments where IPv6 resolves but has no working egress.
|
|
if [ "$FORCE_IPV4_DNS" = "true" ] || [ "$FORCE_IPV4_DNS" = "1" ]; then
|
|
if [ -n "${NODE_OPTIONS:-}" ]; then
|
|
export NODE_OPTIONS="${NODE_OPTIONS} --dns-result-order=ipv4first"
|
|
else
|
|
export NODE_OPTIONS="--dns-result-order=ipv4first"
|
|
fi
|
|
echo "INFO: Enabled IPv4-first DNS ordering (NODE_OPTIONS=--dns-result-order=ipv4first)"
|
|
fi
|
|
|
|
# HA add-ons mount persistent storage at /config (maps to /addon_configs/<slug> on the host).
|
|
export HOME=/config
|
|
|
|
# Explicitly set OpenClaw directories to ensure they persist across add-on updates
|
|
# This prevents loss of installed skills, configuration, and workspace state
|
|
export OPENCLAW_CONFIG_DIR=/config/.openclaw
|
|
export OPENCLAW_WORKSPACE_DIR=/config/clawd
|
|
export XDG_CONFIG_HOME=/config
|
|
|
|
mkdir -p /config/.openclaw /config/.openclaw/identity /config/clawd /config/keys /config/secrets
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Sync built-in OpenClaw skills from image to persistent storage
|
|
# On each startup, copy new/updated built-in skills so they survive rebuilds.
|
|
# We sync them to /config/.openclaw/skills and symlink back.
|
|
# NOTE: We cannot use `npm root -g` here because HOME=/config may contain a
|
|
# persisted .npmrc with a custom prefix from a previous run. Instead, we
|
|
# resolve the real image path by temporarily overriding HOME.
|
|
# ------------------------------------------------------------------------------
|
|
IMAGE_SKILLS_DIR="$(HOME=/root npm root -g 2>/dev/null)/openclaw/skills"
|
|
PERSISTENT_SKILLS_DIR="/config/.openclaw/skills"
|
|
|
|
if [ -d "$IMAGE_SKILLS_DIR" ] && [ ! -L "$IMAGE_SKILLS_DIR" ]; then
|
|
mkdir -p "$PERSISTENT_SKILLS_DIR"
|
|
# Sync skills: --update replaces older files so upgrades propagate,
|
|
# but doesn't delete user-added files in persistent storage.
|
|
if command -v rsync >/dev/null 2>&1; then
|
|
rsync -a --update "$IMAGE_SKILLS_DIR/" "$PERSISTENT_SKILLS_DIR/" 2>/dev/null || true
|
|
else
|
|
cp -ru "$IMAGE_SKILLS_DIR/"* "$PERSISTENT_SKILLS_DIR/" 2>/dev/null || true
|
|
fi
|
|
# Replace image skills dir with symlink to persistent copy
|
|
rm -rf "$IMAGE_SKILLS_DIR"
|
|
ln -sf "$PERSISTENT_SKILLS_DIR" "$IMAGE_SKILLS_DIR"
|
|
echo "INFO: Synced built-in skills to persistent storage at $PERSISTENT_SKILLS_DIR"
|
|
elif [ -L "$IMAGE_SKILLS_DIR" ]; then
|
|
echo "INFO: Built-in skills already linked to persistent storage"
|
|
else
|
|
echo "WARN: Built-in skills directory not found at $IMAGE_SKILLS_DIR"
|
|
fi
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Persist user-installed node skills across Docker image rebuilds
|
|
# Redirect npm/pnpm global installs to /config/.node_global (persistent storage)
|
|
# so that skills installed via the dashboard survive container rebuilds.
|
|
# NOTE: This MUST come after the skills sync above (which needs the original npm root -g).
|
|
# ------------------------------------------------------------------------------
|
|
PERSISTENT_NODE_GLOBAL="/config/.node_global"
|
|
mkdir -p "$PERSISTENT_NODE_GLOBAL"
|
|
npm config set prefix "$PERSISTENT_NODE_GLOBAL" 2>/dev/null || true
|
|
export PATH="${PERSISTENT_NODE_GLOBAL}/bin:${PATH}"
|
|
export NODE_PATH="${PERSISTENT_NODE_GLOBAL}/lib/node_modules:${NODE_PATH:-}"
|
|
|
|
# Also configure pnpm global dir to persistent storage
|
|
export PNPM_HOME="${PERSISTENT_NODE_GLOBAL}/pnpm"
|
|
mkdir -p "$PNPM_HOME"
|
|
export PATH="${PNPM_HOME}:${PATH}"
|
|
|
|
# Protect critical runtime variables from accidental override via gateway_env_vars.
|
|
is_reserved_gateway_env_var() {
|
|
case "$1" in
|
|
# Critical runtime paths/process vars.
|
|
HOME|PATH|PWD|OLDPWD|SHLVL|TZ|XDG_CONFIG_HOME|PNPM_HOME|NODE_PATH|NODE_OPTIONS|NODE_NO_WARNINGS)
|
|
return 0
|
|
;;
|
|
# Low-level injection vectors that can alter process/linker/shell behavior.
|
|
LD_*|DYLD_*|BASH_ENV|ENV|BASH_FUNC_*)
|
|
return 0
|
|
;;
|
|
# Proxy vars managed by add-on options.
|
|
HTTP_PROXY|HTTPS_PROXY|NO_PROXY|http_proxy|https_proxy|no_proxy)
|
|
return 0
|
|
;;
|
|
# Add-on internal control vars.
|
|
OPENCLAW_*)
|
|
return 0
|
|
;;
|
|
*)
|
|
return 1
|
|
;;
|
|
esac
|
|
}
|
|
|
|
try_export_gateway_env_var() {
|
|
local key="$1"
|
|
local value="$2"
|
|
|
|
if [ -z "$key" ]; then
|
|
return 0
|
|
fi
|
|
|
|
# Validate variable name format
|
|
if ! [[ "$key" =~ ^[A-Za-z_][A-Za-z0-9_]*$ ]]; then
|
|
echo "WARN: Invalid environment variable name: '$key' (must start with letter/underscore, skip)"
|
|
return 0
|
|
fi
|
|
|
|
# Protect critical runtime variables from accidental override.
|
|
if is_reserved_gateway_env_var "$key"; then
|
|
echo "WARN: Reserved environment variable '$key' cannot be overridden via gateway_env_vars (skip)"
|
|
return 0
|
|
fi
|
|
|
|
# Enforce max variable name length
|
|
if [ ${#key} -gt $max_var_name_size ]; then
|
|
echo "WARN: Environment variable name too long: '$key' (max $max_var_name_size chars, skip)"
|
|
return 0
|
|
fi
|
|
|
|
# Enforce max variable value length
|
|
if [ ${#value} -gt $max_var_value_size ]; then
|
|
echo "WARN: Environment variable value too long for '$key' (max $max_var_value_size chars, skip)"
|
|
return 0
|
|
fi
|
|
|
|
# Enforce limit on number of variables
|
|
if [ $env_count -ge $max_env_vars ]; then
|
|
echo "WARN: Maximum environment variables limit ($max_env_vars) reached (skip)"
|
|
return 0
|
|
fi
|
|
|
|
export "$key=$value"
|
|
env_count=$((env_count + 1))
|
|
echo "INFO: Exported gateway env var: $key"
|
|
}
|
|
|
|
# Export gateway environment variables from add-on config
|
|
# These are user-defined variables that should be available to the gateway process.
|
|
# Primary format: array of {name, value} objects.
|
|
if [ "$GW_ENV_VARS_TYPE" = "array" ] || [ "$GW_ENV_VARS_TYPE" = "object" ] || { [ "$GW_ENV_VARS_TYPE" = "string" ] && [ -n "$GW_ENV_VARS_RAW" ]; }; then
|
|
env_count=0
|
|
max_env_vars=50
|
|
max_var_name_size=255
|
|
max_var_value_size=10000
|
|
|
|
if [ "$GW_ENV_VARS_TYPE" = "array" ] && [ "$GW_ENV_VARS_JSON" != "[]" ]; then
|
|
echo "INFO: Setting gateway environment variables from list config..."
|
|
|
|
invalid_entries_count=$(printf '%s' "$GW_ENV_VARS_JSON" | jq '[.[] | select((type != "object") or ((.name | type) != "string") or (has("value") | not))] | length')
|
|
if [ "$invalid_entries_count" -gt 0 ]; then
|
|
echo "WARN: Found $invalid_entries_count invalid gateway_env_vars entries; expected objects with 'name' and 'value' keys (skip)"
|
|
fi
|
|
|
|
while IFS= read -r -d '' key && IFS= read -r -d '' value; do
|
|
try_export_gateway_env_var "$key" "$value"
|
|
done < <(printf '%s' "$GW_ENV_VARS_JSON" | jq -j '.[] | select((type == "object") and ((.name | type) == "string") and (has("value"))) | .name, "\u0000", (.value | tostring), "\u0000"')
|
|
elif [ "$GW_ENV_VARS_TYPE" = "object" ] && [ "$GW_ENV_VARS_JSON" != "{}" ]; then
|
|
# Backward compatibility for old map/object configuration.
|
|
echo "INFO: Setting gateway environment variables from object config (legacy format)..."
|
|
while IFS= read -r -d '' key && IFS= read -r -d '' value; do
|
|
try_export_gateway_env_var "$key" "$value"
|
|
done < <(printf '%s' "$GW_ENV_VARS_JSON" | jq -j 'to_entries[] | .key, "\u0000", (.value | tostring), "\u0000"')
|
|
elif [ "$GW_ENV_VARS_TYPE" = "string" ] && [ -n "$GW_ENV_VARS_RAW" ]; then
|
|
# Preferred for complex values: JSON object string in one line.
|
|
if printf '%s' "$GW_ENV_VARS_RAW" | jq -e 'type == "object"' >/dev/null 2>&1; then
|
|
echo "INFO: Setting gateway environment variables from JSON string config..."
|
|
while IFS= read -r -d '' key && IFS= read -r -d '' value; do
|
|
try_export_gateway_env_var "$key" "$value"
|
|
done < <(printf '%s' "$GW_ENV_VARS_RAW" | jq -j 'to_entries[] | .key, "\u0000", (.value | tostring), "\u0000"')
|
|
else
|
|
# Supported simple format: KEY=VALUE pairs separated by ';' or newlines.
|
|
echo "INFO: Setting gateway environment variables from KEY=VALUE string config..."
|
|
while IFS= read -r entry; do
|
|
entry="${entry%$'\r'}"
|
|
trimmed="$(printf '%s' "$entry" | sed -E 's/^[[:space:]]+//;s/[[:space:]]+$//')"
|
|
|
|
# Skip empty lines and comments.
|
|
if [ -z "$trimmed" ] || [[ "$trimmed" == \#* ]]; then
|
|
continue
|
|
fi
|
|
|
|
if [[ "$trimmed" != *"="* ]]; then
|
|
echo "WARN: Invalid gateway_env_vars entry '$trimmed' (expected KEY=VALUE, skip)"
|
|
continue
|
|
fi
|
|
|
|
key="${trimmed%%=*}"
|
|
value="${trimmed#*=}"
|
|
key="$(printf '%s' "$key" | sed -E 's/^[[:space:]]+//;s/[[:space:]]+$//')"
|
|
|
|
try_export_gateway_env_var "$key" "$value"
|
|
done < <(printf '%s' "$GW_ENV_VARS_RAW" | tr ';' '\n')
|
|
fi
|
|
fi
|
|
|
|
if [ $env_count -gt 0 ]; then
|
|
echo "INFO: Successfully exported $env_count gateway environment variable(s)"
|
|
fi
|
|
elif [ "$GW_ENV_VARS_TYPE" != "null" ]; then
|
|
echo "WARN: Invalid gateway_env_vars format in add-on options (expected list, string or object), skipping"
|
|
fi
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Persist Linuxbrew/Homebrew across Docker image rebuilds
|
|
# Homebrew installs to /home/linuxbrew/.linuxbrew/ which is ephemeral.
|
|
# We sync it to /config/.linuxbrew and symlink back so brew-installed CLI
|
|
# tools (gog, gh, bw, etc.) survive add-on updates.
|
|
# ------------------------------------------------------------------------------
|
|
IMAGE_BREW_DIR="/home/linuxbrew/.linuxbrew"
|
|
PERSISTENT_BREW_DIR="/config/.linuxbrew"
|
|
|
|
if [ -d "$IMAGE_BREW_DIR" ] && [ ! -L "$IMAGE_BREW_DIR" ]; then
|
|
# Image has a real Homebrew install — sync to persistent storage
|
|
if [ -d "$PERSISTENT_BREW_DIR" ]; then
|
|
# Persistent copy exists: sync new/updated files from image (upgrades),
|
|
# but preserve user-installed packages already in persistent storage.
|
|
if command -v rsync >/dev/null 2>&1; then
|
|
rsync -a --update "$IMAGE_BREW_DIR/" "$PERSISTENT_BREW_DIR/" 2>/dev/null || true
|
|
else
|
|
cp -ru "$IMAGE_BREW_DIR/"* "$PERSISTENT_BREW_DIR/" 2>/dev/null || true
|
|
fi
|
|
echo "INFO: Synced Homebrew updates to persistent storage"
|
|
else
|
|
# First time: copy entire Homebrew install to persistent storage
|
|
cp -a "$IMAGE_BREW_DIR" "$PERSISTENT_BREW_DIR" 2>/dev/null || true
|
|
echo "INFO: Copied Homebrew to persistent storage at $PERSISTENT_BREW_DIR"
|
|
fi
|
|
# Replace image dir with symlink to persistent copy
|
|
rm -rf "$IMAGE_BREW_DIR"
|
|
ln -sf "$PERSISTENT_BREW_DIR" "$IMAGE_BREW_DIR"
|
|
elif [ -L "$IMAGE_BREW_DIR" ]; then
|
|
echo "INFO: Homebrew already linked to persistent storage"
|
|
elif [ -d "$PERSISTENT_BREW_DIR" ]; then
|
|
# Image doesn't have Homebrew (failed install?) but persistent copy exists
|
|
mkdir -p "$(dirname "$IMAGE_BREW_DIR")"
|
|
ln -sf "$PERSISTENT_BREW_DIR" "$IMAGE_BREW_DIR"
|
|
echo "INFO: Restored Homebrew symlink from persistent storage"
|
|
else
|
|
echo "INFO: Homebrew not available (install may have failed during image build)"
|
|
fi
|
|
|
|
# Back-compat: some docs/scripts assume /data; point it at /config.
|
|
if [ ! -e /data ]; then
|
|
ln -s /config /data || true
|
|
fi
|
|
|
|
# Ensure the agents base directory exists so cleanup scans work even before first run.
|
|
# Do NOT pre-create agent-specific directories; OpenClaw creates them as needed.
|
|
mkdir -p /config/.openclaw/agents || true
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# SINGLE-INSTANCE GUARD (prevents multiple gateway runs racing each other)
|
|
# ------------------------------------------------------------------------------
|
|
STARTUP_LOCK="/config/.openclaw/gateway.start.lock"
|
|
exec 9>"$STARTUP_LOCK"
|
|
if ! flock -n 9; then
|
|
echo "ERROR: Another instance appears to be running (could not acquire $STARTUP_LOCK)."
|
|
echo "If this is wrong, check for stuck processes or remove the lock file."
|
|
exit 1
|
|
fi
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Session lock cleanup helpers
|
|
# ------------------------------------------------------------------------------
|
|
|
|
gateway_running() {
|
|
pgrep -f "openclaw-gateway" >/dev/null 2>&1
|
|
}
|
|
|
|
cleanup_session_locks() {
|
|
local agents_dir="/config/.openclaw/agents"
|
|
local total_locks=0
|
|
local cleaned_dirs=()
|
|
|
|
# Scan all agent session directories, not just 'main'.
|
|
# This is needed for users who have gateway.forcedAgentId set to a non-default agent.
|
|
shopt -s nullglob
|
|
local all_locks=()
|
|
for agent_sessions_dir in "${agents_dir}"/*/sessions; do
|
|
local agent_locks=( "${agent_sessions_dir}"/*.jsonl.lock )
|
|
if [ ${#agent_locks[@]} -gt 0 ]; then
|
|
all_locks+=( "${agent_locks[@]}" )
|
|
cleaned_dirs+=( "$agent_sessions_dir" )
|
|
total_locks=$(( total_locks + ${#agent_locks[@]} ))
|
|
fi
|
|
done
|
|
shopt -u nullglob
|
|
|
|
if [ "$total_locks" -eq 0 ]; then
|
|
return 0
|
|
fi
|
|
|
|
# If gateway is running, do NOT remove locks automatically (could be real).
|
|
if gateway_running; then
|
|
echo "INFO: Gateway appears to be running; leaving session lock files untouched."
|
|
echo "INFO: Locks present: $total_locks"
|
|
return 0
|
|
fi
|
|
|
|
echo "INFO: Removing stale session lock files ($total_locks) across agents: ${cleaned_dirs[*]}"
|
|
for agent_sessions_dir in "${cleaned_dirs[@]}"; do
|
|
rm -f "${agent_sessions_dir}"/*.jsonl.lock || true
|
|
done
|
|
}
|
|
|
|
if [ "$CLEAN_LOCKS_ON_START" = "true" ]; then
|
|
cleanup_session_locks
|
|
else
|
|
echo "INFO: clean_session_locks_on_start=false; skipping session lock cleanup."
|
|
fi
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Store tokens / export env vars (optional)
|
|
# ------------------------------------------------------------------------------
|
|
|
|
if [ -n "$HA_TOKEN" ]; then
|
|
umask 077
|
|
printf '%s' "$HA_TOKEN" > /config/secrets/homeassistant.token
|
|
fi
|
|
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# OpenClaw config is managed by OpenClaw itself (onboarding / configure).
|
|
# This add-on intentionally does NOT create/patch /config/.openclaw/openclaw.json.
|
|
# ------------------------------------------------------------------------------
|
|
|
|
# Convenience info for later (router SSH access path & HA token file)
|
|
cat > /config/CONNECTION_NOTES.txt <<EOF
|
|
Home Assistant token (if set): /config/secrets/homeassistant.token
|
|
Router SSH (generic):
|
|
host=${ROUTER_HOST}
|
|
user=${ROUTER_USER}
|
|
key=${ROUTER_KEY}
|
|
EOF
|
|
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Graceful shutdown handling (PID 1 trap) to reduce stale locks
|
|
# ------------------------------------------------------------------------------
|
|
GW_PID=""
|
|
GW_RELAY_PID=""
|
|
NGINX_PID=""
|
|
TTYD_PID=""
|
|
SHUTTING_DOWN="false"
|
|
|
|
shutdown() {
|
|
SHUTTING_DOWN="true"
|
|
echo "Shutdown requested; stopping services..."
|
|
|
|
if [ -n "${NGINX_PID}" ] && kill -0 "${NGINX_PID}" >/dev/null 2>&1; then
|
|
kill -TERM "${NGINX_PID}" >/dev/null 2>&1 || true
|
|
wait "${NGINX_PID}" || true
|
|
fi
|
|
|
|
if [ -n "${TTYD_PID}" ] && kill -0 "${TTYD_PID}" >/dev/null 2>&1; then
|
|
kill -TERM "${TTYD_PID}" >/dev/null 2>&1 || true
|
|
wait "${TTYD_PID}" || true
|
|
fi
|
|
|
|
if [ -n "${GW_PID}" ] && kill -0 "${GW_PID}" >/dev/null 2>&1; then
|
|
kill -TERM "${GW_PID}" >/dev/null 2>&1 || true
|
|
# wait reaps child PIDs; for non-child (re-tracked) PIDs it fails instantly,
|
|
# so fall back to a timed kill -0 poll to let the gateway finish cleanly.
|
|
if ! wait "${GW_PID}" 2>/dev/null; then
|
|
for _i in 1 2 3 4 5; do
|
|
kill -0 "${GW_PID}" 2>/dev/null || break
|
|
sleep 1
|
|
done
|
|
fi
|
|
fi
|
|
|
|
stop_gw_relay
|
|
|
|
if [ "$CLEAN_LOCKS_ON_EXIT" = "true" ]; then
|
|
cleanup_session_locks || true
|
|
fi
|
|
}
|
|
|
|
trap shutdown INT TERM
|
|
|
|
if ! command -v openclaw >/dev/null 2>&1; then
|
|
echo "ERROR: openclaw is not installed."
|
|
exit 1
|
|
fi
|
|
|
|
# Bootstrap minimal OpenClaw config ONLY if missing.
|
|
# We do not overwrite or patch existing configs; onboarding owns everything else.
|
|
OPENCLAW_CONFIG_PATH="/config/.openclaw/openclaw.json"
|
|
if [ ! -f "$OPENCLAW_CONFIG_PATH" ]; then
|
|
echo "INFO: OpenClaw config missing; bootstrapping minimal config at $OPENCLAW_CONFIG_PATH"
|
|
python3 - <<'PY'
|
|
import json
|
|
import secrets
|
|
from pathlib import Path
|
|
|
|
cfg_path = Path('/config/.openclaw/openclaw.json')
|
|
cfg_path.parent.mkdir(parents=True, exist_ok=True)
|
|
|
|
cfg = {
|
|
"gateway": {
|
|
"mode": "local",
|
|
"port": 18789,
|
|
"bind": "loopback",
|
|
"auth": {
|
|
"mode": "token",
|
|
"token": secrets.token_urlsafe(24)
|
|
}
|
|
},
|
|
"agents": {
|
|
"defaults": {
|
|
"workspace": "/config/clawd"
|
|
}
|
|
}
|
|
}
|
|
|
|
cfg_path.write_text(json.dumps(cfg, indent=2) + "\n", encoding='utf-8')
|
|
print("INFO: Wrote minimal OpenClaw config (gateway.mode=local, auth.token generated)")
|
|
PY
|
|
fi
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Apply gateway LAN mode settings safely using helper script
|
|
# This updates gateway.bind and gateway.port without touching other settings
|
|
# ------------------------------------------------------------------------------
|
|
export OPENCLAW_CONFIG_PATH="/config/.openclaw/openclaw.json"
|
|
|
|
# Find the helper script (copied to root in Dockerfile, or fallback to add-on dir)
|
|
HELPER_PATH="/oc_config_helper.py"
|
|
if [ ! -f "$HELPER_PATH" ] && [ -f "$(dirname "$0")/oc_config_helper.py" ]; then
|
|
HELPER_PATH="$(dirname "$0")/oc_config_helper.py"
|
|
fi
|
|
|
|
if [ -f "$OPENCLAW_CONFIG_PATH" ]; then
|
|
if [ -f "$HELPER_PATH" ]; then
|
|
# In lan_https mode the gateway uses an internal port; nginx owns the external one.
|
|
EFFECTIVE_GW_PORT="$GATEWAY_INTERNAL_PORT"
|
|
if ! python3 "$HELPER_PATH" apply-gateway-settings "$GATEWAY_MODE" "$GATEWAY_REMOTE_URL" "$GATEWAY_BIND_MODE" "$EFFECTIVE_GW_PORT" "$ENABLE_OPENAI_API" "$GATEWAY_AUTH_MODE" "$GATEWAY_TRUSTED_PROXIES"; then
|
|
rc=$?
|
|
echo "ERROR: Failed to apply gateway settings via oc_config_helper.py (exit code ${rc})."
|
|
echo "ERROR: Gateway configuration may be incorrect; aborting startup."
|
|
exit "${rc}"
|
|
fi
|
|
else
|
|
echo "WARN: oc_config_helper.py not found, cannot apply gateway settings"
|
|
echo "INFO: Ensure the add-on image includes oc_config_helper.py and restart"
|
|
fi
|
|
else
|
|
echo "WARN: OpenClaw config not found at $OPENCLAW_CONFIG_PATH, cannot apply gateway settings"
|
|
echo "INFO: Run 'openclaw onboard' first, then restart the add-on"
|
|
fi
|
|
|
|
if [ "$GATEWAY_AUTH_MODE" = "trusted-proxy" ]; then
|
|
echo "NOTICE: gateway_auth_mode=trusted-proxy is enabled."
|
|
echo "NOTICE: Direct local CLI calls to the gateway may return unauthorized (trusted_proxy_user_missing) unless identity headers are injected by your reverse proxy."
|
|
echo "NOTICE: For local terminal CLI workflows, temporarily switch to token auth or use commands that don't require direct gateway WS auth."
|
|
fi
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# TLS certificate generation for built-in HTTPS proxy (lan_https mode)
|
|
# Generates a local CA + server cert so phones/tablets get proper HTTPS.
|
|
# The CA cert can be installed once on a device for trusted access.
|
|
# ------------------------------------------------------------------------------
|
|
LAN_IP=""
|
|
if [ "$ENABLE_HTTPS_PROXY" = "true" ]; then
|
|
CERT_DIR="/config/certs"
|
|
mkdir -p "$CERT_DIR"
|
|
|
|
# Detect primary LAN IP
|
|
LAN_IP=$(hostname -I 2>/dev/null | awk '{print $1}')
|
|
STORED_IP=$(cat "$CERT_DIR/.cert_ip" 2>/dev/null || echo "")
|
|
|
|
# --- Local CA (generated once, persists across restarts) ---
|
|
if [ ! -f "$CERT_DIR/ca.key" ] || [ ! -f "$CERT_DIR/ca.crt" ]; then
|
|
echo "INFO: Generating local CA certificate (one-time)..."
|
|
openssl genrsa -out "$CERT_DIR/ca.key" 2048 2>/dev/null
|
|
openssl req -new -x509 -key "$CERT_DIR/ca.key" -out "$CERT_DIR/ca.crt" \
|
|
-days 3650 -nodes -subj "/CN=OpenClaw Local CA" 2>/dev/null
|
|
chmod 600 "$CERT_DIR/ca.key"
|
|
STORED_IP="" # force server cert regeneration
|
|
echo "INFO: Local CA created at $CERT_DIR/ca.crt"
|
|
fi
|
|
|
|
# --- Extra SANs from gateway_additional_allowed_origins + gateway_public_url ---
|
|
EXTRA_SANS=""
|
|
EXTRA_SAN_SOURCES="${GATEWAY_ADDITIONAL_ALLOWED_ORIGINS},${GW_PUBLIC_URL}"
|
|
if [ "$EXTRA_SAN_SOURCES" != "," ]; then
|
|
EXTRA_SANS="$(python3 - "$EXTRA_SAN_SOURCES" "${LAN_IP:-}" <<'PY'
|
|
import sys, re
|
|
from urllib.parse import urlparse
|
|
raw = sys.argv[1] if len(sys.argv) > 1 else ""
|
|
lan_ip = sys.argv[2] if len(sys.argv) > 2 else ""
|
|
entries = [e.strip() for e in raw.split(",") if e.strip()]
|
|
sans = []
|
|
seen = {"127.0.0.1", "localhost", "homeassistant", "homeassistant.local"}
|
|
if lan_ip:
|
|
seen.add(lan_ip)
|
|
for entry in entries:
|
|
if "://" not in entry:
|
|
entry = "https://" + entry
|
|
host = urlparse(entry).hostname or ""
|
|
if host and host not in seen:
|
|
seen.add(host)
|
|
if re.match(r"^\d{1,3}(\.\d{1,3}){3}$", host):
|
|
sans.append(f"IP:{host}")
|
|
else:
|
|
sans.append(f"DNS:{host}")
|
|
print(",".join(sans), end="")
|
|
PY
|
|
)"
|
|
fi
|
|
STORED_EXTRA_SANS=$(cat "$CERT_DIR/.cert_extra_sans" 2>/dev/null || echo "")
|
|
|
|
# --- Server cert (regenerated when LAN IP or SANs change) ---
|
|
if [ ! -f "$CERT_DIR/gateway.crt" ] || [ ! -f "$CERT_DIR/gateway.key" ] || [ "$LAN_IP" != "$STORED_IP" ] || [ "$EXTRA_SANS" != "$STORED_EXTRA_SANS" ]; then
|
|
echo "INFO: Generating server TLS certificate for IP: ${LAN_IP:-unknown}..."
|
|
openssl genrsa -out "$CERT_DIR/gateway.key" 2048 2>/dev/null
|
|
openssl req -new -key "$CERT_DIR/gateway.key" -out "$CERT_DIR/gateway.csr" \
|
|
-subj "/CN=OpenClaw Gateway" 2>/dev/null
|
|
|
|
# SAN extension — include LAN IP, loopback, common mDNS names + user extras
|
|
cat > "$CERT_DIR/_san.ext" <<SANEOF
|
|
subjectAltName=IP:${LAN_IP:-127.0.0.1},IP:127.0.0.1,DNS:localhost,DNS:homeassistant,DNS:homeassistant.local${EXTRA_SANS:+,${EXTRA_SANS}}
|
|
SANEOF
|
|
|
|
openssl x509 -req -in "$CERT_DIR/gateway.csr" \
|
|
-CA "$CERT_DIR/ca.crt" -CAkey "$CERT_DIR/ca.key" -CAcreateserial \
|
|
-out "$CERT_DIR/gateway.crt" -days 3650 \
|
|
-extfile "$CERT_DIR/_san.ext" 2>/dev/null
|
|
|
|
rm -f "$CERT_DIR/gateway.csr" "$CERT_DIR/_san.ext" "$CERT_DIR/ca.srl"
|
|
chmod 600 "$CERT_DIR/gateway.key"
|
|
printf '%s' "$LAN_IP" > "$CERT_DIR/.cert_ip"
|
|
printf '%s' "$EXTRA_SANS" > "$CERT_DIR/.cert_extra_sans"
|
|
echo "INFO: Server TLS certificate generated (SAN: IP:${LAN_IP:-127.0.0.1}${EXTRA_SANS:+,${EXTRA_SANS}})"
|
|
else
|
|
echo "INFO: Reusing existing TLS certificate (IP: $STORED_IP)"
|
|
fi
|
|
|
|
# Make CA cert available for download via nginx
|
|
mkdir -p /etc/nginx/html
|
|
cp "$CERT_DIR/ca.crt" /etc/nginx/html/openclaw-ca.crt 2>/dev/null || true
|
|
echo "INFO: CA certificate available for download at /cert/ca.crt on the HTTPS port"
|
|
|
|
fi
|
|
|
|
# ------------------------------------------------------------------
|
|
# Configure gateway.controlUi.allowedOrigins:
|
|
# - In lan_https: include HTTPS proxy defaults (LAN IP + common hostnames)
|
|
# - In all modes: also include origin from gateway_public_url when present
|
|
# - Helper merges with existing origins + user extras and deduplicates
|
|
# ------------------------------------------------------------------
|
|
if [ -f "$HELPER_PATH" ] && [ -f "$OPENCLAW_CONFIG_PATH" ]; then
|
|
ALLOWED_ORIGINS=""
|
|
|
|
if [ "$ENABLE_HTTPS_PROXY" = "true" ] && [ -n "$LAN_IP" ]; then
|
|
ALLOWED_ORIGINS="https://${LAN_IP}:${GATEWAY_PORT}"
|
|
ALLOWED_ORIGINS="${ALLOWED_ORIGINS},https://homeassistant.local:${GATEWAY_PORT}"
|
|
ALLOWED_ORIGINS="${ALLOWED_ORIGINS},https://homeassistant:${GATEWAY_PORT}"
|
|
fi
|
|
|
|
if [ -n "$GW_PUBLIC_URL" ]; then
|
|
GW_PUBLIC_ORIGIN="$(python3 - "$GW_PUBLIC_URL" <<'PY'
|
|
import sys
|
|
from urllib.parse import urlparse
|
|
u = (sys.argv[1] or '').strip()
|
|
p = urlparse(u)
|
|
if p.scheme in ('http', 'https') and p.netloc:
|
|
print(f"{p.scheme}://{p.netloc}", end='')
|
|
PY
|
|
)"
|
|
if [ -n "$GW_PUBLIC_ORIGIN" ]; then
|
|
if [ -n "$ALLOWED_ORIGINS" ]; then
|
|
ALLOWED_ORIGINS="${ALLOWED_ORIGINS},${GW_PUBLIC_ORIGIN}"
|
|
else
|
|
ALLOWED_ORIGINS="$GW_PUBLIC_ORIGIN"
|
|
fi
|
|
fi
|
|
fi
|
|
|
|
python3 "$HELPER_PATH" set-control-ui-origins "$ALLOWED_ORIGINS" "$GATEWAY_ADDITIONAL_ALLOWED_ORIGINS" "$CONTROLUI_DISABLE_DEVICE_AUTH" || \
|
|
echo "WARN: Could not set controlUi settings — gateway may reject the Control UI"
|
|
fi
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Proxy shim for undici/OpenClaw startup
|
|
# Keep official OpenClaw npm release while enabling HTTP(S)_PROXY support.
|
|
# ------------------------------------------------------------------------------
|
|
OPENCLAW_GLOBAL_NODE_MODULES="$(HOME=/root npm root -g 2>/dev/null || true)"
|
|
if [ -f /usr/local/lib/openclaw-proxy-shim.cjs ]; then
|
|
if [ -n "${NODE_OPTIONS:-}" ]; then
|
|
export NODE_OPTIONS="--require /usr/local/lib/openclaw-proxy-shim.cjs ${NODE_OPTIONS}"
|
|
else
|
|
export NODE_OPTIONS="--require /usr/local/lib/openclaw-proxy-shim.cjs"
|
|
fi
|
|
export OPENCLAW_GLOBAL_NODE_MODULES
|
|
fi
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Auto-configure MCP (Model Context Protocol) for Home Assistant
|
|
# Registers HA as an MCP server so OpenClaw can control HA entities/services.
|
|
# Requires: homeassistant_token set in add-on options + mcporter CLI available.
|
|
# Runs once; re-runs when the token changes.
|
|
# Auto-detects HA API URL: supervisor proxy if available, else localhost:8123.
|
|
# ------------------------------------------------------------------------------
|
|
if [ "$AUTO_CONFIGURE_MCP" = "true" ] && [ -n "$HA_TOKEN" ]; then
|
|
if command -v mcporter >/dev/null 2>&1; then
|
|
# Detect HA API URL: prefer supervisor proxy (works in all add-on network modes),
|
|
# fall back to localhost:8123 (works with host_network: true).
|
|
if [ -n "${SUPERVISOR_TOKEN:-}" ]; then
|
|
MCP_HA_URL="http://supervisor/core/api/mcp"
|
|
else
|
|
MCP_HA_URL="http://localhost:8123/api/mcp"
|
|
fi
|
|
MCP_FLAG="/config/.openclaw/.mcp_ha_configured"
|
|
MCP_TOKEN_HASH=$(printf '%s' "$HA_TOKEN" | sha256sum | cut -d' ' -f1)
|
|
|
|
if [ -f "$MCP_FLAG" ] && [ "$(cat "$MCP_FLAG" 2>/dev/null)" = "$MCP_TOKEN_HASH" ]; then
|
|
echo "INFO: MCP Home Assistant server already configured (token unchanged)"
|
|
else
|
|
echo "INFO: Configuring MCP for Home Assistant at $MCP_HA_URL ..."
|
|
# Remove stale entry if present (token may have changed)
|
|
mcporter config remove HA 2>/dev/null || true
|
|
|
|
if mcporter config add HA "$MCP_HA_URL" \
|
|
--header "Authorization=Bearer $HA_TOKEN" \
|
|
--scope home 2>&1; then
|
|
printf '%s' "$MCP_TOKEN_HASH" > "$MCP_FLAG"
|
|
echo "INFO: MCP server 'HA' registered — OpenClaw can now control Home Assistant"
|
|
else
|
|
echo "WARN: MCP auto-configuration failed. Configure manually in the terminal:"
|
|
echo "WARN: mcporter config add HA \"$MCP_HA_URL\" --header \"Authorization=Bearer YOUR_TOKEN\" --scope home"
|
|
fi
|
|
fi
|
|
else
|
|
echo "INFO: mcporter not available; skipping MCP auto-configuration (run 'openclaw onboard' first)"
|
|
fi
|
|
elif [ "$AUTO_CONFIGURE_MCP" = "true" ] && [ -z "$HA_TOKEN" ]; then
|
|
echo "INFO: MCP auto-configure enabled but homeassistant_token not set — skipping"
|
|
echo "INFO: To auto-configure, set homeassistant_token in add-on Configuration, then restart"
|
|
fi
|
|
|
|
start_openclaw_runtime() {
|
|
echo "Starting OpenClaw Assistant runtime (openclaw)..."
|
|
if [ "$GATEWAY_MODE" = "remote" ]; then
|
|
# Remote mode: do NOT start a local gateway service.
|
|
# Start a node/client host that connects to the configured remote gateway URL.
|
|
# Use $GATEWAY_REMOTE_URL directly from add-on options — do NOT read back via
|
|
# 'openclaw config get' which can time out at startup or return redacted values.
|
|
REMOTE_URL="$GATEWAY_REMOTE_URL"
|
|
if [ -z "$REMOTE_URL" ]; then
|
|
echo "ERROR: gateway_mode=remote but gateway_remote_url is not set in add-on options"
|
|
echo "ERROR: Set gateway_remote_url in add-on Configuration (e.g. ws://192.168.1.10:18789), then restart"
|
|
return 1
|
|
fi
|
|
|
|
NODE_HOST=""
|
|
NODE_PORT=""
|
|
NODE_TLS_FLAG=""
|
|
if ! eval "$(python3 - "$REMOTE_URL" <<'PY'
|
|
import sys
|
|
from urllib.parse import urlparse
|
|
url = (sys.argv[1] or '').strip()
|
|
p = urlparse(url)
|
|
if p.scheme not in ('ws', 'wss') or not p.hostname:
|
|
print('echo "ERROR: Invalid gateway.remote.url (expected ws:// or wss://): %s"' % url.replace('"', '\\"'))
|
|
print('exit 1')
|
|
raise SystemExit(0)
|
|
port = p.port or (443 if p.scheme == 'wss' else 80)
|
|
print(f'NODE_HOST={p.hostname}')
|
|
print(f'NODE_PORT={port}')
|
|
print(f'NODE_TLS_FLAG={"--tls" if p.scheme == "wss" else ""}')
|
|
PY
|
|
)"; then
|
|
echo "ERROR: Failed to parse gateway.remote.url: $REMOTE_URL"
|
|
return 1
|
|
fi
|
|
|
|
echo "INFO: gateway_mode=remote detected; starting node host to $NODE_HOST:$NODE_PORT ${NODE_TLS_FLAG}"
|
|
# shellcheck disable=SC2086
|
|
openclaw node run --host "$NODE_HOST" --port "$NODE_PORT" $NODE_TLS_FLAG &
|
|
else
|
|
openclaw gateway run &
|
|
fi
|
|
GW_PID=$!
|
|
return 0
|
|
}
|
|
|
|
# --- Loopback relay helpers for tailnet bind mode (issue #90) ---
|
|
# When gateway.bind=tailnet the gateway only listens on the Tailscale IP.
|
|
# The local CLI always tries ws://127.0.0.1:PORT and fails with
|
|
# "Gateway not running" even though the gateway is healthy.
|
|
# These functions start/stop a lightweight Node.js TCP relay on
|
|
# 127.0.0.1:PORT -> TAILSCALE_IP:PORT so terminal CLI commands work.
|
|
# IMPORTANT: stop_gw_relay must be called before restarting the gateway;
|
|
# otherwise the relay holds the loopback port and the new gateway instance
|
|
# detects it as "already listening" and exits with code 1.
|
|
start_gw_relay() {
|
|
if [ "$GATEWAY_BIND_MODE" != "tailnet" ]; then
|
|
return 0
|
|
fi
|
|
local ts_ip
|
|
ts_ip=$(ip -4 addr show tailscale0 2>/dev/null \
|
|
| awk '/inet /{gsub(/\/.*/,"",$2); print $2; exit}' || true)
|
|
if [[ "${ts_ip:-}" =~ ^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
|
|
echo "INFO: Starting loopback relay for tailnet gateway (127.0.0.1:${GATEWAY_PORT} -> ${ts_ip}:${GATEWAY_PORT})"
|
|
node -e "
|
|
const net = require('net');
|
|
const TARGET_HOST = '${ts_ip}';
|
|
const TARGET_PORT = ${GATEWAY_PORT};
|
|
const server = net.createServer(function(c) {
|
|
const t = net.createConnection(TARGET_PORT, TARGET_HOST);
|
|
c.pipe(t); t.pipe(c);
|
|
c.on('error', function() { t.destroy(); });
|
|
t.on('error', function() { c.destroy(); });
|
|
});
|
|
server.listen(TARGET_PORT, '127.0.0.1');" &
|
|
GW_RELAY_PID=$!
|
|
echo "INFO: Loopback relay started (PID ${GW_RELAY_PID})"
|
|
else
|
|
echo "WARN: tailnet bind mode active but Tailscale IP not found on tailscale0 interface."
|
|
echo "WARN: Terminal CLI may show gateway as unreachable. Ensure Tailscale is running and restart."
|
|
fi
|
|
}
|
|
|
|
stop_gw_relay() {
|
|
if [ -n "${GW_RELAY_PID}" ] && kill -0 "${GW_RELAY_PID}" >/dev/null 2>&1; then
|
|
kill -TERM "${GW_RELAY_PID}" >/dev/null 2>&1 || true
|
|
wait "${GW_RELAY_PID}" 2>/dev/null || true
|
|
GW_RELAY_PID=""
|
|
fi
|
|
}
|
|
|
|
if ! start_openclaw_runtime; then
|
|
exit 1
|
|
fi
|
|
|
|
start_gw_relay
|
|
|
|
# Start web terminal (optional)
|
|
TTYD_PID_FILE="/var/run/openclaw-ttyd.pid"
|
|
|
|
# Clean up stale ttyd process from previous run using PID file
|
|
if [ -f "$TTYD_PID_FILE" ]; then
|
|
OLD_PID=$(cat "$TTYD_PID_FILE" 2>/dev/null || echo "")
|
|
if [ -n "$OLD_PID" ] && kill -0 "$OLD_PID" 2>/dev/null; then
|
|
echo "Stopping previous ttyd process (PID $OLD_PID)..."
|
|
kill "$OLD_PID" 2>/dev/null || true
|
|
sleep 1
|
|
# Force kill if still running
|
|
kill -9 "$OLD_PID" 2>/dev/null || true
|
|
fi
|
|
rm -f "$TTYD_PID_FILE"
|
|
fi
|
|
|
|
if [ "$ENABLE_TERMINAL" = "true" ] || [ "$ENABLE_TERMINAL" = "1" ]; then
|
|
# Check if the terminal port is already in use before starting ttyd
|
|
if command -v ss >/dev/null 2>&1 && ss -tlnp 2>/dev/null | grep -q ":${TERMINAL_PORT} "; then
|
|
echo ""
|
|
echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
|
|
echo "!! WARNING: terminal_port ${TERMINAL_PORT} IS ALREADY IN USE !!"
|
|
echo "!! !!"
|
|
echo "!! The web terminal (ttyd) may FAIL to start because port !!"
|
|
echo "!! ${TERMINAL_PORT} appears to be in use by another process. !!"
|
|
echo "!! !!"
|
|
echo "!! ACTION REQUIRED: If the terminal does not work, go to !!"
|
|
echo "!! Add-on Configuration and change 'terminal_port' to a free !!"
|
|
echo "!! port, then restart the add-on. !!"
|
|
echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
|
|
echo ""
|
|
fi
|
|
echo "Starting web terminal (ttyd) on 127.0.0.1:${TERMINAL_PORT} ..."
|
|
ttyd -W -i 127.0.0.1 -p "${TERMINAL_PORT}" -b /terminal bash &
|
|
TTYD_PID=$!
|
|
echo "$TTYD_PID" > "$TTYD_PID_FILE"
|
|
echo "ttyd started with PID $TTYD_PID"
|
|
else
|
|
echo "Terminal disabled (enable_terminal=$ENABLE_TERMINAL)"
|
|
fi
|
|
|
|
# Start ingress reverse proxy (nginx). This provides the add-on UI inside HA.
|
|
# Token is injected server-side; never put it in the browser URL.
|
|
NGINX_PID_FILE="/var/run/openclaw-nginx.pid"
|
|
|
|
# Clean up stale nginx process from previous run (e.g., after crash/unclean restart)
|
|
if [ -f "$NGINX_PID_FILE" ]; then
|
|
OLD_NGINX_PID=$(cat "$NGINX_PID_FILE" 2>/dev/null || echo "")
|
|
if [ -n "$OLD_NGINX_PID" ] && kill -0 "$OLD_NGINX_PID" 2>/dev/null; then
|
|
echo "Stopping previous nginx process (PID $OLD_NGINX_PID)..."
|
|
kill "$OLD_NGINX_PID" 2>/dev/null || true
|
|
sleep 1
|
|
kill -9 "$OLD_NGINX_PID" 2>/dev/null || true
|
|
fi
|
|
rm -f "$NGINX_PID_FILE"
|
|
fi
|
|
# Also kill any orphaned nginx workers that might hold port 48099
|
|
if command -v pkill >/dev/null 2>&1; then
|
|
pkill -f "nginx.*-c /etc/nginx/nginx.conf" 2>/dev/null || true
|
|
sleep 1
|
|
fi
|
|
# Verify port 48099 is actually free before proceeding
|
|
if command -v ss >/dev/null 2>&1 && ss -tlnp 2>/dev/null | grep -q ':48099 '; then
|
|
echo "WARN: Port 48099 still in use after cleanup; nginx may fail to start"
|
|
fi
|
|
|
|
# Render nginx config from template.
|
|
# The gateway token is NOT managed by the add-on; OpenClaw will generate/store it.
|
|
# Read directly from config file — the CLI redacts secrets since v2026.2.22+.
|
|
GW_TOKEN="$(python3 -c "
|
|
import json, os
|
|
p = os.environ.get('OPENCLAW_CONFIG_PATH', '/config/.openclaw/openclaw.json')
|
|
print(json.load(open(p)).get('gateway',{}).get('auth',{}).get('token',''), end='')
|
|
" 2>/dev/null || true)"
|
|
|
|
# Collect disk usage for landing page status card
|
|
DISK_TOTAL="" DISK_USED="" DISK_AVAIL="" DISK_PCT=""
|
|
if df -h /config >/dev/null 2>&1; then
|
|
DISK_TOTAL=$(df -h /config | awk 'NR==2{print $2}')
|
|
DISK_USED=$(df -h /config | awk 'NR==2{print $3}')
|
|
DISK_AVAIL=$(df -h /config | awk 'NR==2{print $4}')
|
|
DISK_PCT=$(df -h /config | awk 'NR==2{print $5}')
|
|
echo "INFO: Disk usage: ${DISK_USED}/${DISK_TOTAL} (${DISK_PCT} used, ${DISK_AVAIL} free)"
|
|
# Warn early if disk is getting full
|
|
DISK_PCT_NUM=${DISK_PCT//%/}
|
|
if [ "$DISK_PCT_NUM" -ge 90 ] 2>/dev/null; then
|
|
echo "WARNING: Disk is ${DISK_PCT} full! Add-on updates may fail. Run 'oc-cleanup' in the terminal."
|
|
elif [ "$DISK_PCT_NUM" -ge 75 ] 2>/dev/null; then
|
|
echo "NOTICE: Disk is ${DISK_PCT} full. Consider running 'oc-cleanup' in the terminal."
|
|
fi
|
|
fi
|
|
|
|
GW_PUBLIC_URL="$GW_PUBLIC_URL" GW_TOKEN="$GW_TOKEN" TERMINAL_PORT="$TERMINAL_PORT" \
|
|
ENABLE_HTTPS_PROXY="$ENABLE_HTTPS_PROXY" HTTPS_PROXY_PORT="$GATEWAY_PORT" \
|
|
GATEWAY_INTERNAL_PORT="$GATEWAY_INTERNAL_PORT" ACCESS_MODE="$ACCESS_MODE" \
|
|
DISK_TOTAL="$DISK_TOTAL" DISK_USED="$DISK_USED" DISK_AVAIL="$DISK_AVAIL" DISK_PCT="$DISK_PCT" \
|
|
NGINX_LOG_LEVEL="$NGINX_LOG_LEVEL" \
|
|
python3 /render_nginx.py
|
|
|
|
echo "Starting ingress proxy (nginx) on :48099 ..."
|
|
nginx -g 'daemon off;' &
|
|
NGINX_PID=$!
|
|
sleep 1
|
|
if kill -0 "$NGINX_PID" 2>/dev/null; then
|
|
echo "$NGINX_PID" > "$NGINX_PID_FILE"
|
|
echo "nginx started with PID $NGINX_PID"
|
|
else
|
|
echo "WARN: nginx failed to start (PID $NGINX_PID exited); ingress UI may be unavailable"
|
|
fi
|
|
|
|
# Keep add-on alive even if gateway/node runtime restarts itself (e.g. during onboarding).
|
|
# If runtime exits unexpectedly, restart it while nginx/ttyd stay up.
|
|
#
|
|
# Design notes (issue #95):
|
|
# `openclaw gateway run` is a thin wrapper that spawns `openclaw-gateway` as a
|
|
# long-running daemon and then exits. When the gateway self-restarts (SIGUSR1 /
|
|
# `openclaw gateway restart`), the old daemon exits and a NEW daemon is forked —
|
|
# the new PID is NOT a child of this shell so `wait` cannot block on it.
|
|
# Strategy:
|
|
# 1. `wait` for our child (the wrapper). When it exits, check if the daemon
|
|
# is still alive (`pgrep`). If yes → re-track and poll with `kill -0`.
|
|
# 2. When the re-tracked daemon eventually exits (crash or another restart),
|
|
# `kill -0` fails, we check again for a live daemon to re-track, or restart.
|
|
GW_IS_CHILD=true # true only when GW_PID was started by us (can use `wait`)
|
|
|
|
while true; do
|
|
if [ "$GW_IS_CHILD" = "true" ]; then
|
|
# Efficient blocking wait on our child process.
|
|
GW_EXIT_CODE=0
|
|
wait "${GW_PID}" 2>/dev/null || GW_EXIT_CODE=$?
|
|
else
|
|
# GW_PID is NOT our child (re-tracked after a self-restart).
|
|
# Poll with kill -0 until it exits.
|
|
while kill -0 "$GW_PID" 2>/dev/null; do
|
|
if [ "$SHUTTING_DOWN" = "true" ]; then break 2; fi
|
|
sleep 5
|
|
done
|
|
GW_EXIT_CODE=0
|
|
fi
|
|
|
|
if [ "$SHUTTING_DOWN" = "true" ]; then
|
|
break
|
|
fi
|
|
|
|
# Give a potential self-restart time to spawn the new daemon.
|
|
sleep 2
|
|
|
|
# Detect self-restart: look for a live `openclaw-gateway` process.
|
|
# If one exists, the runtime restarted itself — re-track and monitor
|
|
# instead of spawning a duplicate (which would collide on the port).
|
|
RESTARTED_PID=""
|
|
if [ "$GATEWAY_MODE" != "remote" ]; then
|
|
RESTARTED_PID=$(pgrep -f "openclaw-gateway" 2>/dev/null | head -1 || true)
|
|
else
|
|
RESTARTED_PID=$(pgrep -f "openclaw.*node.*run" 2>/dev/null | head -1 || true)
|
|
fi
|
|
|
|
if [ -n "$RESTARTED_PID" ]; then
|
|
echo "INFO: OpenClaw runtime restarted itself (new PID $RESTARTED_PID); monitoring."
|
|
GW_PID="$RESTARTED_PID"
|
|
GW_IS_CHILD=false
|
|
continue
|
|
fi
|
|
|
|
echo "WARN: OpenClaw runtime exited with code ${GW_EXIT_CODE}. Restarting in 2s..."
|
|
sleep 2
|
|
|
|
# Stop the loopback relay BEFORE restarting the gateway (tailnet mode only).
|
|
# The relay holds 127.0.0.1:GATEWAY_PORT — leaving it up causes the new gateway
|
|
# to detect the port as occupied and exit with code 1, re-entering the loop.
|
|
stop_gw_relay
|
|
|
|
if ! start_openclaw_runtime; then
|
|
echo "ERROR: Failed to restart OpenClaw runtime; retrying in 5s..."
|
|
sleep 5
|
|
else
|
|
GW_IS_CHILD=true
|
|
start_gw_relay
|
|
fi
|
|
done
|