docs(photon): document immutable-install sidecar resolution (setup step + sidecar README)

This commit is contained in:
Teknium 2026-07-28 22:36:13 -07:00
parent 7d5ddf8c33
commit 244759114a
No known key found for this signature in database
2 changed files with 11 additions and 2 deletions

View file

@ -21,7 +21,11 @@ npm install
```
The Hermes plugin's `hermes photon setup` command runs `npm install`
here automatically.
automatically. When the plugin directory is read-only (Docker/Podman
images, immutable install trees), deps resolve through
`sidecar_paths.resolve_sidecar_dir()`: an explicit `PHOTON_SIDECAR_DIR`
override → writable-in-place → a baked image copy → a mirror under
`~/.hermes/photon/sidecar` (created and installed on demand).
## Run standalone

View file

@ -73,7 +73,12 @@ The setup, in order:
user with that number already exists, so re-running is safe.
5. **Prints your assigned iMessage line** — the number you text to reach
your agent.
6. **Runs `npm install`** inside the plugin's sidecar directory.
6. **Runs `npm install`** for the sidecar. On writable source checkouts this
installs into the plugin's own `sidecar/` directory; on read-only or
immutable installs (Docker/Podman images, hosted deployments) the deps
resolve to a baked image copy or are mirrored under
`~/.hermes/photon/sidecar` automatically. Set `PHOTON_SIDECAR_DIR` to
override the location explicitly.
Runtime credentials are written to `~/.hermes/.env`
(`PHOTON_PROJECT_ID` = the Spectrum project id, `PHOTON_PROJECT_SECRET`),