From d7aa344f097c256e8bde6559de511df0cf10c404 Mon Sep 17 00:00:00 2001 From: Christopher Vagnetoft Date: Sat, 17 Jan 2026 18:32:17 +0100 Subject: [PATCH] Update readme --- README.md | 36 ++++++++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e18cabb..3dc67b6 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,21 @@ pushing notifications to *ntfy.sh* or private instances of ntfy. This daemon does **not** support subscriptions for now, only publishing. +> [!IMPORTANT] +> This is not a replacement for ntfy.sh, it is a complement to avoid having to +> configure multiple services in a stack, and to create abstractions for topic +> names. + +## Building + +Ntfi is built using **box**. You can compile it right away with `box compile`, +but the recommended way is using the Makefile to ensure the version information +is included: + +```bash +$ make phar +``` + ## Using Bare metal (Linux): @@ -33,6 +48,7 @@ as the `compose.yaml` file. services: ntfi: image: dev.noccylabs.info/noccylabs/ntfi:latest + # only include ports if you need to publish from outside of the stack ports: - 13000:13000 volumes: @@ -53,12 +69,12 @@ Configure the servers that you want to be able to relay notifications to. The default configuration defines a single server, `default` which is configured to send messages to *ntfy.sh* as an anonymous user. -| Key | Req | Detail -| --- | --- | --- -| `server` | Y | The server name without protocol (always https) -| `token` | \- | API token to use when authenticating -| `username` | \- | Username for authenticating -| `password` | \- | Password for authenticating +| Key | Req | Detail +| ----------- | :-: | ------------------------------------------------ +| `server` | Y | The server name without protocol (always https) +| `token` | \- | API token to use when authenticating +| `username` | \- | Username for authenticating +| `password` | \- | Password for authenticating > [!NOTE] > Note that for authentication to work, you need to specify *either* `token`, @@ -70,9 +86,9 @@ to send messages to *ntfy.sh* as an anonymous user. These are the channels that can be sent to. Each channel name matches the request URL, and placeholders can be used to extract and reassemble a destination topic. -| Key | Req | Detail -| --- | --- | --- -| `destination` | Y | The destination, as `/` +| Key | Req | Detail +| -------------- | :-: | --------------------------------------------- +| `destination` | Y | The destination, as `/` Examples: @@ -86,4 +102,4 @@ Examples: # or append a prefix to the topic, sending to yet another server "{topic}": destination: "prefixing/prefix_{topic}" -``` \ No newline at end of file +```