client.yml 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. # ntfy client config file
  2. # Base URL used to expand short topic names in the "ntfy publish" and "ntfy subscribe" commands.
  3. # If you self-host a ntfy server, you'll likely want to change this.
  4. #
  5. # default-host: https://ntfy.sh
  6. # Default credentials will be used with "ntfy publish" and "ntfy subscribe" if no other credentials are provided.
  7. # You can set a default token to use or a default user:password combination, but not both. For an empty password,
  8. # use empty double-quotes ("").
  9. #
  10. # To override the default user:password combination or default token for a particular subscription (e.g., to send
  11. # no Authorization header), set the user:pass/token for the subscription to empty double-quotes ("").
  12. # default-token:
  13. # default-user:
  14. # default-password:
  15. # Default command will execute after "ntfy subscribe" receives a message if no command is provided in subscription below
  16. # default-command:
  17. # Subscriptions to topics and their actions. This option is primarily used by the systemd service,
  18. # or if you cann "ntfy subscribe --from-config" directly.
  19. #
  20. # Example:
  21. # subscribe:
  22. # - topic: mytopic
  23. # command: /usr/local/bin/mytopic-triggered.sh
  24. # - topic: myserver.com/anothertopic
  25. # command: 'echo "$message"'
  26. # if:
  27. # priority: high,urgent
  28. # - topic: secret
  29. # command: 'notify-send "$m"'
  30. # user: phill
  31. # password: mypass
  32. # - topic: token_topic
  33. # token: tk_AgQdq7mVBoFD37zQVN29RhuMzNIz2
  34. #
  35. # Variables:
  36. # Variable Aliases Description
  37. # --------------- --------------------- -----------------------------------
  38. # $NTFY_ID $id Unique message ID
  39. # $NTFY_TIME $time Unix timestamp of the message delivery
  40. # $NTFY_TOPIC $topic Topic name
  41. # $NTFY_MESSAGE $message, $m Message body
  42. # $NTFY_TITLE $title, $t Message title
  43. # $NTFY_PRIORITY $priority, $prio, $p Message priority (1=min, 5=max)
  44. # $NTFY_TAGS $tags, $tag, $ta Message tags (comma separated list)
  45. # $NTFY_RAW $raw Raw JSON message
  46. #
  47. # Filters ('if:'):
  48. # You can filter 'message', 'title', 'priority' (comma-separated list, logical OR)
  49. # and 'tags' (comma-separated list, logical AND). See https://ntfy.sh/docs/subscribe/api/#filter-messages.
  50. #
  51. # subscribe: