docs: clarify gateway service scopes (#1378)

This commit is contained in:
Teknium 2026-03-14 21:17:41 -07:00 committed by GitHub
parent 6b1adb7eb1
commit 95939a1b51
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 45 additions and 16 deletions

View file

@ -156,7 +156,8 @@ What they do:
**Cron execution is handled by the gateway daemon.** The gateway ticks the scheduler every 60 seconds, running any due jobs in isolated agent sessions.
```bash
hermes gateway install # Install as system service (recommended)
hermes gateway install # Install as a user service
sudo hermes gateway install --system # Linux: boot-time system service for servers
hermes gateway # Or run in foreground
hermes cron list

View file

@ -80,7 +80,8 @@ EMAIL_HOME_ADDRESS=your@email.com # Default delivery target for cron jobs
```bash
hermes gateway # Run in foreground
hermes gateway install # Install as a system service
hermes gateway install # Install as a user service
sudo hermes gateway install --system # Linux only: boot-time system service
```
On startup, the adapter:

View file

@ -54,10 +54,12 @@ This walks you through configuring each platform with arrow-key selection, shows
```bash
hermes gateway # Run in foreground
hermes gateway setup # Configure messaging platforms interactively
hermes gateway install # Install as systemd service (Linux) / launchd (macOS)
hermes gateway start # Start the service
hermes gateway stop # Stop the service
hermes gateway status # Check service status
hermes gateway install # Install as a user service (Linux) / launchd service (macOS)
sudo hermes gateway install --system # Linux only: install a boot-time system service
hermes gateway start # Start the default service
hermes gateway stop # Stop the default service
hermes gateway status # Check default service status
hermes gateway status --system # Linux only: inspect the system service explicitly
```
## Chat Commands (Inside Messaging)
@ -188,8 +190,18 @@ journalctl --user -u hermes-gateway -f
# Enable lingering (keeps running after logout)
sudo loginctl enable-linger $USER
# Or install a boot-time system service that still runs as your user
sudo hermes gateway install --system
sudo hermes gateway start --system
sudo hermes gateway status --system
journalctl -u hermes-gateway -f
```
Use the user service on laptops and dev boxes. Use the system service on VPS or headless hosts that should come back at boot without relying on systemd linger.
Avoid keeping both the user and system gateway units installed at once unless you really mean to. Hermes will warn if it detects both because start/stop/status behavior gets ambiguous.
### macOS (launchd)
```bash

View file

@ -127,7 +127,8 @@ Then start the gateway:
```bash
hermes gateway # Foreground
hermes gateway install # Install as a system service
hermes gateway install # Install as a user service
sudo hermes gateway install --system # Linux only: boot-time system service
```
---

View file

@ -168,7 +168,8 @@ Then start the gateway:
```bash
hermes gateway # Foreground
hermes gateway install # Install as a system service
hermes gateway install # Install as a user service
sudo hermes gateway install --system # Linux only: boot-time system service
```
---

View file

@ -101,7 +101,8 @@ Then start the gateway:
```bash
hermes gateway # Foreground
hermes gateway install # Install as a system service
hermes gateway install # Install as a user service
sudo hermes gateway install --system # Linux only: boot-time system service
```
The gateway starts the WhatsApp bridge automatically using the saved session.