ARIA
b1c9bac7d8
- 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)
72 lines
2.5 KiB
YAML
72 lines
2.5 KiB
YAML
name: iris-platform
|
|
label: Iris
|
|
kind: platform
|
|
version: 0.1.0
|
|
description: >
|
|
Native Android / Desktop client gateway adapter for Hermes Agent.
|
|
Runs an HTTP server (optional TLS) inside the gateway; the app connects
|
|
with a pairing token. Supports streaming, reasoning, structured tool
|
|
events, channels/threads, media, FTS5 search, and FCM/ntfy push.
|
|
author: Iris x Hermes
|
|
# ``requires_env`` / ``optional_env`` entries are surfaced in the
|
|
# ``hermes config`` / ``hermes gateway setup`` UI via the platform-plugin
|
|
# env var injector in ``hermes_cli/config.py``.
|
|
requires_env:
|
|
- name: IRIS_TOKEN
|
|
description: "Shared pairing token the app presents on connect"
|
|
prompt: "Iris pairing token"
|
|
password: true
|
|
optional_env:
|
|
- name: IRIS_HTTP_HOST
|
|
description: "HTTP bind host (default 127.0.0.1; use 0.0.0.0 for LAN)"
|
|
prompt: "HTTP host"
|
|
password: false
|
|
- name: IRIS_HTTP_PORT
|
|
description: "HTTP port (default 8791)"
|
|
prompt: "HTTP port"
|
|
password: false
|
|
- name: IRIS_HOME_CHANNEL
|
|
description: "Default chat id for cron/notification delivery (default: default)"
|
|
prompt: "Home channel"
|
|
password: false
|
|
- name: IRIS_ALLOWED_USERS
|
|
description: "Comma-separated allowed device_ids (empty = token-only auth)"
|
|
prompt: "Allowed device ids"
|
|
password: false
|
|
- name: IRIS_ALLOW_ALL_USERS
|
|
description: "Allow any paired device (dev only)"
|
|
prompt: "Allow all devices? (true/false)"
|
|
password: false
|
|
- name: IRIS_PUSH_BACKEND
|
|
description: "Push backend: ntfy (default, keeps metadata off Google) or fcm"
|
|
prompt: "Push backend"
|
|
password: false
|
|
- name: IRIS_FCM_SERVICE_ACCOUNT
|
|
description: "Path to Firebase service-account JSON (FCM HTTP v1)"
|
|
prompt: "FCM service account path"
|
|
password: true
|
|
- name: IRIS_FCM_SERVER_KEY
|
|
description: "Legacy FCM server key (fallback if no service account)"
|
|
prompt: "FCM server key"
|
|
password: true
|
|
- name: NTFY_TOPIC
|
|
description: "ntfy topic for push (when IRIS_PUSH_BACKEND=ntfy)"
|
|
prompt: "ntfy topic"
|
|
password: false
|
|
- name: NTFY_SERVER_URL
|
|
description: "ntfy server URL (default https://ntfy.sh)"
|
|
prompt: "ntfy server URL"
|
|
password: false
|
|
- name: NTFY_AUTH_TOKEN
|
|
description: "ntfy auth token for a private topic (trust boundary)"
|
|
prompt: "ntfy auth token"
|
|
password: true
|
|
- name: IRIS_HTTP_CERT
|
|
description: "TLS cert path for HTTPS (optional)"
|
|
prompt: "HTTPS cert"
|
|
password: false
|
|
- name: IRIS_HTTP_KEY
|
|
description: "TLS key path for HTTPS (optional)"
|
|
prompt: "HTTPS key"
|
|
password: false
|