Zakaria
57 lines
2.2 KiB
YAML
57 lines
2.2 KiB
YAML
name: ntfy-platform
|
|
label: ntfy
|
|
kind: platform
|
|
version: 1.0.0
|
|
description: >
|
|
ntfy push-notification gateway adapter for Hermes Agent.
|
|
Subscribes to a topic on ntfy.sh or any self-hosted ntfy server via
|
|
HTTP streaming, and publishes replies via HTTP POST. Lightweight —
|
|
no external SDK, only httpx (already a Hermes dependency).
|
|
|
|
ntfy has no native user-identity primitive; the adapter treats each
|
|
topic as a single trusted channel and never derives user identity
|
|
from publisher-controlled fields. Use a private topic + read token
|
|
for any real trust boundary.
|
|
author: sprmn24
|
|
# ``requires_env`` and ``optional_env`` entries are surfaced in the
|
|
# ``hermes config`` UI via the platform-plugin env var injector in
|
|
# ``hermes_cli/config.py``.
|
|
requires_env:
|
|
- name: NTFY_TOPIC
|
|
description: "Topic name to subscribe to (e.g. hermes-in)"
|
|
prompt: "ntfy subscribe topic"
|
|
password: false
|
|
optional_env:
|
|
- name: NTFY_SERVER_URL
|
|
description: "ntfy server URL (default: https://ntfy.sh)"
|
|
prompt: "ntfy server URL"
|
|
password: false
|
|
- name: NTFY_TOKEN
|
|
description: "Bearer token or 'user:pass' for Basic auth (optional)"
|
|
prompt: "ntfy auth token (or empty)"
|
|
password: true
|
|
- name: NTFY_PUBLISH_TOPIC
|
|
description: "Topic to publish replies to (defaults to NTFY_TOPIC)"
|
|
prompt: "ntfy publish topic (or empty)"
|
|
password: false
|
|
- name: NTFY_MARKDOWN
|
|
description: "Send replies with X-Markdown: true header (true/false, default: false)"
|
|
prompt: "Enable markdown formatting? (true/false)"
|
|
password: false
|
|
- name: NTFY_ALLOWED_USERS
|
|
description: "Comma-separated topic names allowed (allowlist)"
|
|
prompt: "Allowed topic names (comma-separated)"
|
|
password: false
|
|
- name: NTFY_ALLOW_ALL_USERS
|
|
description: "Allow any topic to talk to the bot (dev only — disables allowlist)"
|
|
prompt: "Allow all topics? (true/false)"
|
|
password: false
|
|
- name: NTFY_HOME_CHANNEL
|
|
description: "Default topic for cron / notification delivery"
|
|
prompt: "Home channel topic (or empty)"
|
|
password: false
|
|
- name: NTFY_HOME_CHANNEL_NAME
|
|
description: "Human label for the home channel (defaults to the topic name)"
|
|
prompt: "Home channel display name (or empty)"
|
|
password: false
|