noccy/ntfi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Christopher Vagnetoft
2026-01-17 18:32:17 +01:00
parent c05cc0c23a
commit d7aa344f09
1 changed files with 26 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -5,6 +5,21 @@ pushing notifications to *ntfy.sh* or private instances of ntfy.
This daemon does **not** support subscriptions for now, only publishing. 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 ## Using
Bare metal (Linux): Bare metal (Linux):
@@ -33,6 +48,7 @@ as the `compose.yaml` file.
services: services:
ntfi: ntfi:
image: dev.noccylabs.info/noccylabs/ntfi:latest image: dev.noccylabs.info/noccylabs/ntfi:latest
# only include ports if you need to publish from outside of the stack
ports: ports:
- 13000:13000 - 13000:13000
volumes: 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 default configuration defines a single server, `default` which is configured
to send messages to *ntfy.sh* as an anonymous user. to send messages to *ntfy.sh* as an anonymous user.
| Key | Req | Detail | Key | Req | Detail
| --- | --- | --- | ----------- | :-: | ------------------------------------------------
| `server` | Y | The server name without protocol (always https) | `server` | Y | The server name without protocol (always https)
| `token` | \- | API token to use when authenticating | `token` | \- | API token to use when authenticating
| `username` | \- | Username for authenticating | `username` | \- | Username for authenticating
| `password` | \- | Password for authenticating | `password` | \- | Password for authenticating
> [!NOTE] > [!NOTE]
> Note that for authentication to work, you need to specify *either* `token`, > 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 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. URL, and placeholders can be used to extract and reassemble a destination topic.
| Key | Req | Detail | Key | Req | Detail
| --- | --- | --- | -------------- | :-: | ---------------------------------------------
| `destination` | Y | The destination, as `<server>/<topic>` | `destination` | Y | The destination, as `<server>/<topic>`
Examples: Examples:
@@ -86,4 +102,4 @@ Examples:
# or append a prefix to the topic, sending to yet another server # or append a prefix to the topic, sending to yet another server
"{topic}": "{topic}":
destination: "prefixing/prefix_{topic}" destination: "prefixing/prefix_{topic}"
``` ```