docs+plugin: HTTP-only transport cleanup, install guide, review fixes
CI / Gateway plugin tests (push) Successful in 5m19s
CI / Kotlin tests (android host + desktop) (push) Successful in 7m3s

- docs/install.md: new end-to-end guide for non-technical users
  (gateway install, app install, LAN/TLS/remote connection, push,
  options, troubleshooting); docs/setup.md now points to it
- README: new 'Install the gateway' section; pairing section updated
  for HTTP transport (8791, QR scan on Android)
- rename IRIS_WS_HOST -> IRIS_HTTP_HOST (clean rename, no compat
  fallback); drop dead DEFAULT_PORT=8790
- setup.py: advertise https:// in the printed/QR server URL when
  IRIS_HTTP_CERT is set
- ws_probe.py/e2e.py: default --url http://127.0.0.1:8791, env
  IRIS_WS_URL -> IRIS_HTTP_URL, honor explicit port + https scheme
- plugin.yaml: IRIS_HTTP_* env names, description no longer says
  'WebSocket server'
- docs 03/09/12/19: fix stale WS-era refs (ws_server.py cites,
  8790 smoke test, WSS->HTTPS, 'HTTP fallback' reframed as the
  only transport)
- AGENTS.md: symlink name android -> iris (matches actual install)
- test: adapter reads IRIS_HTTP_HOST/CERT/KEY from env; legacy
  IRIS_WS_* names are not consulted (95/95 pass)
This commit is contained in:
ARIA committed 2026-08-24 22:22:02 +02:00
1 parent a61b47a947
commit b1c9bac7d8
18 files changed
+472 -317

No files matched your search

+14 -15
View File
@@ -101,8 +101,8 @@ IRIS_FCM_SERVICE_ACCOUNT=/path/to/service-account.json
# IRIS_FCM_SERVER_KEY=<legacy key> # fallback if no service account
# NTFY_TOPIC=iris-push # when ntfy
# NTFY_SERVER_URL=https://ntfy.sh
# IRIS_WS_CERT=/path/cert.pem # WSS
# IRIS_WS_KEY=/path/key.pem
# IRIS_HTTP_CERT=/path/cert.pem # HTTPS
# IRIS_HTTP_KEY=/path/key.pem
```
**Behavioral (`~/.hermes/config.yaml`):**
@@ -114,7 +114,7 @@ gateway:
enabled: true
extra:
host: 127.0.0.1 # 0.0.0.0 for LAN
port: 8790
http_port: 8791
home_channel: default
push_backend: fcm
outbox_retention_hours: 72
@@ -134,18 +134,17 @@ display:
# 1. gateway up with plugin
hermes gateway status | grep -i iris
# 2. a raw WS client can pair + echo
python - <<'PY'
import asyncio, json, websockets
async def main():
async with websockets.connect("ws://127.0.0.1:8790/ws") as ws:
await ws.send(json.dumps({"v":1,"type":"hello","payload":{
"token":"<IRIS_TOKEN>","device_id":"test","device_name":"probe",
"caps":{"min_protocol":1}}}))
print("recv:", await ws.recv())
asyncio.run(main())
PY
# 2. the HTTP server answers (unauthenticated liveness)
curl -s http://127.0.0.1:8791/v1/health
# -> {"ok": true}
# 3. a frame round-trip with the pairing token
curl -s -X POST http://127.0.0.1:8791/v1/frame \
-H "Authorization: Bearer <IRIS_TOKEN>" -H "X-Iris-Device: probe" \
-H "Content-Type: application/json" \
-d '{"v":1,"type":"commands.catalog","id":1,"payload":{}}'
```
Expect a `hello.ack`. If you get `error {code:"auth"}`, the token/host/port is
Expect `{"ok": true}` from the health probe and a `commands.catalog` reply
frame from the POST. If you get `401`, the token/host/port is
wrong.