vbatts/ntfy
1
0
Fork 0
Code Pull requests Activity

Add NTFY_RAW

Browse source
This commit is contained in:
Philipp Heckel 2021-12-23 00:16:28 +01:00
parent 85939618c8
commit 6779d9dd1f
4 changed files with 33 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
client/client.yml
View file

@ -18,15 +18,16 @@
# priority: high,urgent # priority: high,urgent
# #
# Variables: # Variables:
# Variable Aliases Description # Variable Aliases Description
# --------------- --------------- ----------------------------------- # --------------- --------------------- -----------------------------------
# $NTFY_ID $id Unique message ID # $NTFY_ID $id Unique message ID
# $NTFY_TIME $time Unix timestamp of the message delivery # $NTFY_TIME $time Unix timestamp of the message delivery
# $NTFY_TOPIC $topic Topic name # $NTFY_TOPIC $topic Topic name
# $NTFY_MESSAGE $message, $m Message body # $NTFY_MESSAGE $message, $m Message body
# $NTFY_TITLE $title, $t Message title # $NTFY_TITLE $title, $t Message title
# $NTFY_PRIORITY $priority, $p Message priority (1=min, 5=max) # $NTFY_PRIORITY $priority, $prio, $p Message priority (1=min, 5=max)
# $NTFY_TAGS $tags, $ta Message tags (comma separated list) # $NTFY_TAGS $tags, $tag, $ta Message tags (comma separated list)
# $NTFY_RAW $raw Raw JSON message
# #
# Filters ('if:'): # Filters ('if:'):
# You can filter 'message', 'title', 'priority' (comma-separated list, logical OR) # You can filter 'message', 'title', 'priority' (comma-separated list, logical OR)

20
cmd/subscribe.go
View file

@ -44,15 +44,16 @@ ntfy subscribe TOPIC COMMAND
This executes COMMAND for every incoming messages. The message fields are passed to the This executes COMMAND for every incoming messages. The message fields are passed to the
command as environment variables: command as environment variables:
Variable Aliases Description Variable Aliases Description
--------------- --------------- ----------------------------------- --------------- --------------------- -----------------------------------
$NTFY_ID $id Unique message ID $NTFY_ID $id Unique message ID
$NTFY_TIME $time Unix timestamp of the message delivery $NTFY_TIME $time Unix timestamp of the message delivery
$NTFY_TOPIC $topic Topic name $NTFY_TOPIC $topic Topic name
$NTFY_MESSAGE $message, $m Message body $NTFY_MESSAGE $message, $m Message body
$NTFY_TITLE $title, $t Message title $NTFY_TITLE $title, $t Message title
$NTFY_PRIORITY $priority, $p Message priority (1=min, 5=max) $NTFY_PRIORITY $priority, $prio, $p Message priority (1=min, 5=max)
$NTFY_TAGS $tags, $ta Message tags (comma separated list) $NTFY_TAGS $tags, $tag, $ta Message tags (comma separated list)
$NTFY_RAW $raw Raw JSON message
Examples: Examples:
ntfy sub mytopic 'notify-send "$m"' # Execute command for incoming messages ntfy sub mytopic 'notify-send "$m"' # Execute command for incoming messages
@ -207,6 +208,7 @@ func envVars(m *client.Message) []string {
env = append(env, envVar(m.Title, "NTFY_TITLE", "title", "t")...) env = append(env, envVar(m.Title, "NTFY_TITLE", "title", "t")...)
env = append(env, envVar(fmt.Sprintf("%d", m.Priority), "NTFY_PRIORITY", "priority", "prio", "p")...) env = append(env, envVar(fmt.Sprintf("%d", m.Priority), "NTFY_PRIORITY", "priority", "prio", "p")...)
env = append(env, envVar(strings.Join(m.Tags, ","), "NTFY_TAGS", "tags", "tag", "ta")...) env = append(env, envVar(strings.Join(m.Tags, ","), "NTFY_TAGS", "tags", "tag", "ta")...)
env = append(env, envVar(m.Raw, "NTFY_RAW", "raw")...)
return env return env
} }

2
docs/subscribe/api.md
View file

@ -231,7 +231,7 @@ Available filters (all case-insensitive):
| Filter variable | Alias | Example | Description | | Filter variable | Alias | Example | Description |
|---|---|---|---| |---|---|---|---|
| `message` | `X-Message`, `m` | `ntfy.sh/mytopic?some_message` | Only return messages that match this exact message string | | `message` | `X-Message`, `m` | `ntfy.sh/mytopic?message=lalala` | Only return messages that match this exact message string |
| `title` | `X-Title`, `t` | `ntfy.sh/mytopic?title=some+title` | Only return messages that match this exact title string | | `title` | `X-Title`, `t` | `ntfy.sh/mytopic?title=some+title` | Only return messages that match this exact title string |
| `priority` | `X-Priority`, `prio`, `p` | `ntfy.sh/mytopic?p=high,urgent` | Only return messages that match *any priority listed* (comma-separated) | | `priority` | `X-Priority`, `prio`, `p` | `ntfy.sh/mytopic?p=high,urgent` | Only return messages that match *any priority listed* (comma-separated) |
| `tags` | `X-Tags`, `tag`, `ta` | `ntfy.sh/mytopic?tags=error,alert` | Only return messages that match *all listed tags* (comma-separated) | | `tags` | `X-Tags`, `tag`, `ta` | `ntfy.sh/mytopic?tags=error,alert` | Only return messages that match *all listed tags* (comma-separated) |

21
docs/subscribe/cli.md
View file

@ -112,6 +112,7 @@ in double-quotes, you should be fine:
| `$NTFY_TITLE` | `$title`, `$t` | Message title | | `$NTFY_TITLE` | `$title`, `$t` | Message title |
| `$NTFY_PRIORITY` | `$priority`, `$prio`, `$p` | Message priority (1=min, 5=max) | | `$NTFY_PRIORITY` | `$priority`, `$prio`, `$p` | Message priority (1=min, 5=max) |
| `$NTFY_TAGS` | `$tags`, `$tag`, `$ta` | Message tags (comma separated list) | | `$NTFY_TAGS` | `$tags`, `$tag`, `$ta` | Message tags (comma separated list) |
| `$NTFY_RAW` | `$raw` | Raw JSON message |
### Subscribe to multiple topics ### Subscribe to multiple topics
``` ```
@ -127,14 +128,14 @@ Here's an example config file that subscribes to three different topics, executi
subscribe: subscribe:
- topic: echo-this - topic: echo-this
command: 'echo "Message received: $message"' command: 'echo "Message received: $message"'
- topic: alerts - topic: alerts
command: notify-send -i /usr/share/ntfy/logo.png "Important" "$m" command: notify-send -i /usr/share/ntfy/logo.png "Important" "$m"
if: if:
priority: high,urgent priority: high,urgent
- topic: calc - topic: calc
command: 'gnome-calculator 2>/dev/null &' command: 'gnome-calculator 2>/dev/null &'
- topic: print-temp - topic: print-temp
command: | command: |
echo "You can easily run inline scripts, too." echo "You can easily run inline scripts, too."
temp="$(sensors | awk '/Pack/ { print substr($4,2,2) }')" temp="$(sensors | awk '/Pack/ { print substr($4,2,2) }')"
if [ $temp -gt 80 ]; then if [ $temp -gt 80 ]; then
@ -142,12 +143,12 @@ Here's an example config file that subscribes to three different topics, executi
else else
echo "CPU temperature is $temp. That's alright." echo "CPU temperature is $temp. That's alright."
fi fi
``` ```
In this example, when `ntfy subscribe --from-config` is executed: In this example, when `ntfy subscribe --from-config` is executed:
* Messages to `echo-this` simply echos to standard out * Messages to `echo-this` simply echos to standard out
* Messages to `alerts` display as desktop notification for high priority messages using `notify-send` * Messages to `alerts` display as desktop notification for high priority messages using [notify-send](https://manpages.ubuntu.com/manpages/focal/man1/notify-send.1.html)
* Messages to `calc` open the gnome calculator 😀 (*because, why not*) * Messages to `calc` open the gnome calculator 😀 (*because, why not*)
* Messages to `print-temp` execute an inline script and print the CPU temperature * Messages to `print-temp` execute an inline script and print the CPU temperature