vbatts/ntfy
1
0
Fork 0
Code Pull requests Activity

Include image file, docs

Browse source
This commit is contained in:
Philipp Heckel 2021-12-22 10:21:59 +01:00
parent 534fca0d3b
commit 66c749d5f0
3 changed files with 16 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.goreleaser.yml
View file

@ -59,6 +59,8 @@ nfpms:
dst: /lib/systemd/system/ntfy-client.service dst: /lib/systemd/system/ntfy-client.service
- dst: /var/cache/ntfy - dst: /var/cache/ntfy
type: dir type: dir
- dst: /usr/share/ntfy/logo.png
src: server/static/img/ntfy.png
scripts: scripts:
preinstall: "scripts/preinst.sh" preinstall: "scripts/preinst.sh"
postinstall: "scripts/postinst.sh" postinstall: "scripts/postinst.sh"

2
cmd/subscribe.go
View file

@ -210,7 +210,7 @@ func envVars(m *client.Message) []string {
env = append(env, envVar(m.Message, "NTFY_MESSAGE", "message", "m")...) env = append(env, envVar(m.Message, "NTFY_MESSAGE", "message", "m")...)
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", "ta")...) env = append(env, envVar(strings.Join(m.Tags, ","), "NTFY_TAGS", "tags", "tag", "ta")...)
return env return env
} }

24
docs/subscribe/cli.md
View file

@ -73,6 +73,7 @@ stays open forever.
$ ntfy sub mytopic $ ntfy sub mytopic
{"id":"nZ8PjH5oox","time":1639971913,"event":"message","topic":"mytopic","message":"hi there"} {"id":"nZ8PjH5oox","time":1639971913,"event":"message","topic":"mytopic","message":"hi there"}
{"id":"sekSLWTujn","time":1639972063,"event":"message","topic":"mytopic",priority:5,"message":"Oh no!"} {"id":"sekSLWTujn","time":1639972063,"event":"message","topic":"mytopic",priority:5,"message":"Oh no!"}
...
``` ```
<figure> <figure>
@ -84,8 +85,8 @@ $ ntfy sub mytopic
``` ```
ntfy subscribe TOPIC COMMAND ntfy subscribe TOPIC COMMAND
``` ```
If you run it like this, a COMMAND is executed for every incoming messages. Here are a few If you run it like this, a COMMAND is executed for every incoming messages. Scroll down to see a list of available
examples: environment variables. Here are a few examples:
``` ```
ntfy sub mytopic 'notify-send "$m"' ntfy sub mytopic 'notify-send "$m"'
@ -109,10 +110,10 @@ in double-quotes, you should be fine:
| `$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) |
### Subscribing to multiple topics ### Subscribe to multiple topics
``` ```
ntfy subscribe --from-config ntfy subscribe --from-config
``` ```
@ -160,18 +161,19 @@ if you install the deb/rpm package. To configure it, simply edit `/etc/ntfy/clie
The `ntfy-client.service` runs as user `ntfy`, meaning that typical Linux permission restrictions apply. See below The `ntfy-client.service` runs as user `ntfy`, meaning that typical Linux permission restrictions apply. See below
for how to fix this. for how to fix this.
If it runs on your personal desktop machine, you may want to override the service user/group (`User=` and `Group=`), and If the service runs on your personal desktop machine, you may want to override the service user/group (`User=` and `Group=`), and
adjust the `DISPLAY` and DBUS environment variables. This will allow you to run commands in your X session as the primary adjust the `DISPLAY` and `DBUS_SESSION_BUS_ADDRESS` environment variables. This will allow you to run commands in your X session
machine user. as the primary machine user.
You can either manually override these systemd service entries with `sudo systemctl edit ntfy-client`, and add this You can either manually override these systemd service entries with `sudo systemctl edit ntfy-client`, and add this
(assuming your user is `pheckel`): (assuming your user is `phil`). Don't forget to run `sudo systemctl daemon-reload` and `sudo systemctl restart ntfy-client`
after editing the service file:
=== "/etc/systemd/system/ntfy-client.service.d/override.conf" === "/etc/systemd/system/ntfy-client.service.d/override.conf"
``` ```
[Service] [Service]
User=pheckel User=phil
Group=pheckel Group=phil
Environment="DISPLAY=:0" "DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus" Environment="DISPLAY=:0" "DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus"
``` ```
Or you can run the following script that creates this override config for you: Or you can run the following script that creates this override config for you: