plugin.yaml 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. name: simplex-platform
  2. label: SimpleX Chat
  3. kind: platform
  4. version: 1.1.0
  5. description: >
  6. SimpleX Chat gateway adapter for Hermes Agent.
  7. Connects to a local simplex-chat daemon via WebSocket and relays
  8. messages between SimpleX contacts/groups and the Hermes agent.
  9. SimpleX is decentralised and assigns no persistent user IDs —
  10. every contact is an opaque internal ID generated at connection
  11. time, making it one of the most private messengers available.
  12. author: Mibayy, jooray
  13. # ``requires_env`` and ``optional_env`` entries are surfaced in the
  14. # ``hermes config`` UI via the platform-plugin env var injector in
  15. # ``hermes_cli/config.py``.
  16. requires_env:
  17. - name: SIMPLEX_WS_URL
  18. description: "WebSocket URL of the simplex-chat daemon (e.g. ws://127.0.0.1:5225)"
  19. prompt: "SimpleX daemon WebSocket URL"
  20. password: false
  21. optional_env:
  22. - name: SIMPLEX_ALLOWED_USERS
  23. description: "Comma-separated SimpleX contact IDs allowed to talk to the bot"
  24. prompt: "Allowed contact IDs (comma-separated)"
  25. password: false
  26. - name: SIMPLEX_ALLOW_ALL_USERS
  27. description: "Allow any contact to talk to the bot (dev only — disables allowlist)"
  28. prompt: "Allow all contacts? (true/false)"
  29. password: false
  30. - name: SIMPLEX_AUTO_ACCEPT
  31. description: "Auto-accept incoming contact requests (default: true)"
  32. prompt: "Auto-accept contact requests? (true/false)"
  33. password: false
  34. - name: SIMPLEX_GROUP_ALLOWED
  35. description: >-
  36. Comma-separated SimpleX group IDs the bot should participate in, or
  37. '*' to allow any group. Omit to ignore group messages entirely
  38. (safer default — a bot in a group otherwise processes every
  39. member's traffic).
  40. prompt: "Allowed group IDs (comma-separated, or '*' for any)"
  41. password: false
  42. - name: SIMPLEX_HOME_CHANNEL
  43. description: "Default contact/group ID for cron / notification delivery"
  44. prompt: "Home channel contact/group ID (or empty)"
  45. password: false
  46. - name: SIMPLEX_HOME_CHANNEL_NAME
  47. description: "Human label for the home channel (defaults to the ID)"
  48. prompt: "Home channel display name (or empty)"
  49. password: false
  50. - name: HERMES_SIMPLEX_TEXT_BATCH_DELAY
  51. description: >-
  52. Quiet-period seconds (default: 0.8) used to concatenate rapid-fire
  53. inbound text messages into a single MessageEvent — same pattern as
  54. Telegram's text batching.
  55. prompt: "Text batch flush delay in seconds (default 0.8)"
  56. password: false