plugin.yaml 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. name: signal-platform
  2. label: Signal
  3. kind: platform
  4. version: 1.0.0
  5. description: >
  6. Signal gateway adapter for Hermes Agent via a signal-cli daemon in HTTP
  7. mode (SSE inbound, JSON-RPC 2.0 outbound). Supports DMs, allowlisted
  8. groups, attachments, reactions and home-channel cron delivery. Phone
  9. numbers are treated as PII in logs.
  10. author: NousResearch
  11. # ``requires_env`` / ``optional_env`` entries are surfaced in the ``hermes config`` UI via the
  12. # platform-plugin env var injector in ``hermes_cli/config.py``.
  13. requires_env:
  14. - name: SIGNAL_HTTP_URL
  15. description: "signal-cli HTTP daemon URL (e.g. http://127.0.0.1:8080)"
  16. prompt: "signal-cli HTTP URL"
  17. url: "https://github.com/AsamK/signal-cli"
  18. password: false
  19. - name: SIGNAL_ACCOUNT
  20. description: "Signal account phone number in E.164 format (e.g. +15551234567)"
  21. prompt: "Signal account number"
  22. password: false
  23. optional_env:
  24. - name: SIGNAL_ALLOWED_USERS
  25. description: "Comma-separated phone numbers or UUIDs allowed to DM the bot"
  26. prompt: "Allowed users (comma-separated)"
  27. password: false
  28. - name: SIGNAL_ALLOW_ALL_USERS
  29. description: "Allow any Signal user to talk to the bot (dev only)"
  30. prompt: "Allow all users? (true/false)"
  31. password: false
  32. - name: SIGNAL_GROUP_ALLOWED_USERS
  33. description: "Comma-separated group IDs allowed to talk to the bot (* for all groups)"
  34. prompt: "Allowed group IDs"
  35. password: false
  36. - name: SIGNAL_REQUIRE_MENTION
  37. description: "Only answer group messages that mention the bot (true/false, default: false)"
  38. prompt: "Require mention in groups? (true/false)"
  39. password: false
  40. - name: SIGNAL_IGNORE_STORIES
  41. description: "Ignore Signal stories (true/false, default: true)"
  42. prompt: "Ignore stories? (true/false)"
  43. password: false
  44. - name: SIGNAL_HOME_CHANNEL
  45. description: "Default chat (phone number or group:<id>) for cron / notification delivery"
  46. prompt: "Home channel"
  47. password: false
  48. - name: SIGNAL_HOME_CHANNEL_NAME
  49. description: "Display name for the Signal home channel"
  50. prompt: "Home channel name"
  51. password: false