Skip to content

Support env-driven service config on macOS #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dafacto wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support env-driven service config on macOS #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,33 @@ curl -fsSL vidclaw.com/install.sh | bash

Installs Node.js, git, Tailscale, and VidClaw in one command. Localhost only: add `--no-tailscale`.

### macOS / non-root OpenClaw installs

VidClaw auto-detects `~/.openclaw` and common Homebrew OpenClaw install paths on macOS. If your OpenClaw install lives somewhere unusual, set environment variables before setup/start:

```bash
export OPENCLAW_DIR="$HOME/.openclaw"
export OPENCLAW_BUNDLED_SKILLS_DIR="/opt/homebrew/lib/node_modules/openclaw/skills"
./setup.sh
```

### Tailscale or custom bind host

Recommended: keep VidClaw bound to localhost and publish it over Tailscale Serve:

```bash
./setup.sh --tailscale
```

If you explicitly want the managed service to bind to another interface instead, set `HOST` before running `./setup.sh`:

```bash
export HOST="100.70.53.60"
./setup.sh
```

`./setup.sh` writes the launchd/systemd service definition. `./start.sh` and `./status.sh` do **not** rewrite that service config, so changing `HOST` or `OPENCLAW_*` variables later only takes effect after running `./setup.sh` again.

## Update

```bash
Expand Down
66 changes: 54 additions & 12 deletions scripts/lib/service.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,52 @@ systemd_escape_exec_arg() {
}

systemd_default_path() {
printf '%s\n' '/usr/local/bin:/usr/bin:/bin'
printf '%s\n' '/opt/homebrew/bin:/usr/local/bin:/usr/bin:/bin'
}

service_env_var_names() {
printf '%s\n' \
NODE_ENV \
PORT \
HOST \
PATH \
OPENCLAW_DIR \
OPENCLAW_BUNDLED_SKILLS_DIR
}

service_env_var_value() {
case "$1" in
NODE_ENV) printf '%s\n' 'production' ;;
PORT) printf '%s\n' "${VIDCLAW_PORT}" ;;
HOST) printf '%s\n' "${HOST:-127.0.0.1}" ;;
PATH) printf '%s\n' '/opt/homebrew/bin:/usr/local/bin:/usr/bin:/bin' ;;
OPENCLAW_DIR) printf '%s\n' "${OPENCLAW_DIR:-${HOME}/.openclaw}" ;;
OPENCLAW_BUNDLED_SKILLS_DIR)
if [[ -n "${OPENCLAW_BUNDLED_SKILLS_DIR:-}" ]]; then
printf '%s\n' "${OPENCLAW_BUNDLED_SKILLS_DIR}"
fi
;;
esac
}

service_environment_lines() {
local format="$1"
local key value
while IFS= read -r key; do
[[ -n "${key}" ]] || continue
value="$(service_env_var_value "${key}")"
[[ -n "${value}" ]] || continue
case "${format}" in
systemd)
printf 'Environment=%s=%s\n' "${key}" "${value}"
;;
launchd)
printf ' <key>%s</key>\n <string>%s</string>\n' "${key}" "${value}"
;;
*)
die "Unsupported service environment format: ${format}" ;;
esac
done < <(service_env_var_names)
}

write_systemd_unit_file() {
Expand All @@ -109,9 +154,10 @@ write_systemd_unit_file() {
tailscale_line="ExecStartPre=-$(tailscale_serve_cmd)"
fi

local run_user run_group
local run_user run_group env_lines
run_user="$(id -un)"
run_group="$(id -gn)"
env_lines="$(service_environment_lines systemd)"

cat > "${tmp_file}" <<EOF
[Unit]
Expand All @@ -125,12 +171,10 @@ User=${run_user}
Group=${run_group}
WorkingDirectory=${REPO_ROOT}
${tailscale_line:+${tailscale_line}
}ExecStart=${escaped_node} ${escaped_entrypoint}
}${env_lines}
ExecStart=${escaped_node} ${escaped_entrypoint}
Restart=always
RestartSec=3
Environment=NODE_ENV=production
Environment=PORT=${VIDCLAW_PORT}
Environment=PATH=$(systemd_default_path)

[Install]
WantedBy=multi-user.target
Expand Down Expand Up @@ -172,6 +216,7 @@ WRAPPER
write_launchd_plist() {
local plist_path="$1"
local program_args
local env_block

if is_tailscale_enabled && [[ -n "${TAILSCALE_BIN:-}" ]]; then
write_launchd_wrapper_script
Expand All @@ -185,6 +230,8 @@ write_launchd_plist() {
</array>"
fi

env_block="$(service_environment_lines launchd)"

cat > "${plist_path}" <<EOF
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
Expand All @@ -201,12 +248,7 @@ ${program_args}

<key>EnvironmentVariables</key>
<dict>
<key>NODE_ENV</key>
<string>production</string>
<key>PORT</key>
<string>${VIDCLAW_PORT}</string>
<key>PATH</key>
<string>/opt/homebrew/bin:/usr/local/bin:/usr/bin:/bin</string>
${env_block}
</dict>

<key>RunAtLoad</key>
Expand Down