plugin.yaml 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. name: ntfy-platform
  2. label: ntfy
  3. kind: platform
  4. version: 1.0.0
  5. description: >
  6. ntfy push-notification gateway adapter for Hermes Agent.
  7. Subscribes to a topic on ntfy.sh or any self-hosted ntfy server via
  8. HTTP streaming, and publishes replies via HTTP POST. Lightweight —
  9. no external SDK, only httpx (already a Hermes dependency).
  10. ntfy has no native user-identity primitive; the adapter treats each
  11. topic as a single trusted channel and never derives user identity
  12. from publisher-controlled fields. Use a private topic + read token
  13. for any real trust boundary.
  14. author: sprmn24
  15. # ``requires_env`` and ``optional_env`` entries are surfaced in the
  16. # ``hermes config`` UI via the platform-plugin env var injector in
  17. # ``hermes_cli/config.py``.
  18. requires_env:
  19. - name: NTFY_TOPIC
  20. description: "Topic name to subscribe to (e.g. hermes-in)"
  21. prompt: "ntfy subscribe topic"
  22. password: false
  23. optional_env:
  24. - name: NTFY_SERVER_URL
  25. description: "ntfy server URL (default: https://ntfy.sh)"
  26. prompt: "ntfy server URL"
  27. password: false
  28. - name: NTFY_TOKEN
  29. description: "Bearer token or 'user:pass' for Basic auth (optional)"
  30. prompt: "ntfy auth token (or empty)"
  31. password: true
  32. - name: NTFY_PUBLISH_TOPIC
  33. description: "Topic to publish replies to (defaults to NTFY_TOPIC)"
  34. prompt: "ntfy publish topic (or empty)"
  35. password: false
  36. - name: NTFY_MARKDOWN
  37. description: "Send replies with X-Markdown: true header (true/false, default: false)"
  38. prompt: "Enable markdown formatting? (true/false)"
  39. password: false
  40. - name: NTFY_ALLOWED_USERS
  41. description: "Comma-separated topic names allowed (allowlist)"
  42. prompt: "Allowed topic names (comma-separated)"
  43. password: false
  44. - name: NTFY_ALLOW_ALL_USERS
  45. description: "Allow any topic to talk to the bot (dev only — disables allowlist)"
  46. prompt: "Allow all topics? (true/false)"
  47. password: false
  48. - name: NTFY_HOME_CHANNEL
  49. description: "Default topic for cron / notification delivery"
  50. prompt: "Home channel topic (or empty)"
  51. password: false
  52. - name: NTFY_HOME_CHANNEL_NAME
  53. description: "Human label for the home channel (defaults to the topic name)"
  54. prompt: "Home channel display name (or empty)"
  55. password: false