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

@ -29,7 +29,8 @@ Before starting, make sure you have:
- **Hermes Agent installed** — see the [Installation guide](/docs/getting-started/installation)
- **Gateway running** — the gateway daemon handles cron execution:
```bash
hermes gateway install # Install as system service (recommended)
hermes gateway install # Install as a user service
sudo hermes gateway install --system # Linux servers: boot-time system service
# or
hermes gateway # Run in foreground
```
@ -242,10 +243,12 @@ Make sure the scheduler is actually running:
hermes cron status
```
If the gateway isn't running, your jobs won't execute. Install it as a system service for reliability:
If the gateway isn't running, your jobs won't execute. Install it as a background service for reliability:
```bash
hermes gateway install
# or on Linux servers
sudo hermes gateway install --system
```
## Going Further

View file

@ -143,12 +143,13 @@ For a persistent deployment that survives reboots:
```bash
hermes gateway install
sudo hermes gateway install --system # Linux only: boot-time system service
```
This creates a **systemd** service (Linux) or **launchd** service (macOS) that runs automatically.
This creates a background service: a user-level **systemd** service on Linux by default, a **launchd** service on macOS, or a boot-time Linux system service if you pass `--system`.
```bash
# Linux — manage the service
# Linux — manage the default user service
hermes gateway start
hermes gateway stop
hermes gateway status
@ -158,6 +159,11 @@ journalctl --user -u hermes-gateway -f
# Keep running after SSH logout
sudo loginctl enable-linger $USER
# Linux servers — explicit system-service commands
sudo hermes gateway start --system
sudo hermes gateway status --system
journalctl -u hermes-gateway -f
```
```bash