Update readme
This commit is contained in:
20
README.md
20
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:
|
||||
@@ -54,7 +70,7 @@ 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
|
||||
@@ -71,7 +87,7 @@ These are the channels that can be sent to. Each channel name matches the reques
|
||||
URL, and placeholders can be used to extract and reassemble a destination topic.
|
||||
|
||||
| Key | Req | Detail
|
||||
| --- | --- | ---
|
||||
| -------------- | :-: | ---------------------------------------------
|
||||
| `destination` | Y | The destination, as `<server>/<topic>`
|
||||
|
||||
Examples:
|
||||
|
||||
Reference in New Issue
Block a user