Bump docs

Author: GamePad64

docs/configuration.md

@@ -8,11 +8,12 @@ All these variables can be passed to executables as command-line arguments (see
 |---------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
 | NOTIFICO_DB               | :material-check: | Database URL used as persistent data storage. <br/>Notifico supports SQLite, PostgreSQL, MySQL (MariaDB) and their derivatives.              |
 | NOTIFICO_SECRET_KEY       | :material-check: | Secret key, used for various needs. Mainly, for creating JWT tokens. Can be any printable sequence.                                          |
-| NOTIFICO_AMQP_URL         | :material-check: | AMQP broker URL address. Virtual hosts are currently not supported. **Example**: `amqp://guest:[email protected]` for local RabbitMQ instance. |
-| NOTIFICO_HTTP_INGEST_BIND | :material-check: | Local address for [ingest](components.md#ingest) service.                                                                                    |
-| NOTIFICO_WEB_BIND         | :material-check: | Local address for [web](components.md#web) service.                                                                                          |
-| NOTIFICO_USERAPI_BIND     | :material-check: | Local address for [userapi](components.md#user-api) service.                                                                                 |
-| NOTIFICO_USERAPI_URL      | :material-check: | User-facing address for userapi service                                                                                                      | |
+| NOTIFICO_AMQP             |                  | AMQP broker URL address. Virtual hosts are currently not supported. **Example**: `amqp://guest:[email protected]` for local RabbitMQ instance. |
+| NOTIFICO_AMQP_PREFIX      |                  | AMQP queue prefix.                                                                                                                           |
+| NOTIFICO_HTTP_INGEST_BIND |                  | Local address for [ingest](components.md#ingest) service.                                                                                    |
+| NOTIFICO_UI_BIND          |                  | Local address for [web](components.md#web) service.                                                                                          |
+| NOTIFICO_PUBLIC_BIND      |                  | Local address for [userapi](components.md#user-api) service.                                                                                 |
+| NOTIFICO_PUBLIC_URL       |                  | User-facing address for userapi service                                                                                                      |
 
 ## Credentials
 

docs/index.md

@@ -19,10 +19,6 @@ This feature provides flexibility and control over how notifications are handled
 Notifications are messages that are sent to users or systems to inform them of events, updates, or actions that require their attention.
 Notifico allows you to send notifications through various channels such as email, SMS, and messengers.
 
-### Channels
-Channels are the mediums through which notifications are delivered. Notifico supports multiple channels, enabling you to reach your users wherever they are.
-You can configure and manage these channels to suit your application's needs.
-
 ### Templates
 Templates are predefined formats for your notifications. They allow you to maintain consistency in your messaging and save time by reusing common structures.
 Notifico supports dynamic content in templates, enabling personalized notifications.

docs/notificox.md

@@ -1,38 +1,48 @@
-# NotificoX
+# Notificox
 
 [![GitHub Release](https://img.shields.io/github/v/release/notificohq/notifico?style=for-the-badge)](https://github.com/notificohq/notifico/releases/latest)
 
-NotificoX is a versatile tool designed to send messages to various services, inspired by the popular notification library, [Apprise](https://github.com/caronc/apprise).
+Notificox is a versatile tool designed to send messages to various services, inspired by the popular notification library, [Apprise](https://github.com/caronc/apprise).
 It provides a unified interface to deliver notifications across multiple platforms, making it easier for users to manage and automate their communication needs.
 
-With NotificoX, you can send messages to a wide range of channels, including email, SMS, and instant messaging services.
+With Notificox, you can send messages to a wide range of channels, including email, SMS, and instant messaging services.
 
 This tool is a single dependency-free binary (only libc and SSL library are required), so you can run it anywhere,
-for example in CI pipelines.
+for example, in CI pipelines.
 
-Some arguments are formatted in [JSON5](https://json5.org/), so they can be entered without numerous escape sequences.
+Some arguments are formatted in [JSON5](https://json5.org/), so they can be entered in console without escape sequences.
 
 ## Send notification locally
 **Usage:**
 ```shell
-notificox send <CREDENTIAL> [CONTACTS]... --template <TEMPLATE>
+notificox send <CREDENTIAL> [CONTACTS]... --context <CONTEXT>
 ```
 
 **Where:**
 
-- TEMPLATE: JSON5-formatted message template object. Template parameters are transport-specific. You can read about template parameters in [Plugins](plugins/core.md) section. Most of the transports require only "body" parameter to be set.
+- CONTEXT: JSON5-formatted message context object. Parameters are transport-specific. You can read about template parameters in [Plugins](plugins/core.md) section. Most of the transports require only "body" parameter to be set.
 - CREDENTIAL: Transport credential. You can read about transport syntax in [Plugins](plugins/core.md) section.
-- CONTACTS: zero or more contacts to send the message. Contact format is transport-specific. Some transports, like Gotify, don't require contacts, as they only use credentials to send.
+- CONTACTS: zero or more contacts to send the message. The Contact format is transport-specific. Some transports, like Gotify, don't require contacts, as they only use credentials to send.
 
 This command internally constructs a Notifico [pipeline](pipeline.md) and executes it using the embedded pipeline engine.
 This process is fully transparent to end user.
 
-### Example
+### Examples
+Sending a Telegram message to recipient with chat_id=111579711 using telegram token:
 ```shell
-# Send a Telegram notification to recipient with chat_id=111579711 using telegram token
-notificox send --template "{body: 'my notification body'}" \
-    "telegram:TOKENTOKEN:TOKENTOKENTOKENTOKENTOKENTOKENTOKEN" \
-    "telegram:111579711"
+notificox send "telegram:TOKEN" "telegram:111579711" -c "{body: 'my notification body'}"
+```
+Sending a Slack message with a PDF file attached:
+```shell
+notificox send "slack:TOKEN" "slack:CHAT_ID" -c "{body: 'my notification body'}" -a ~/file.pdf
+```
+Sending a [ntfy.io](plugins/ntfy.md) message with templating enabled:
+```shell
+notificox send "ntfy:https://ntfy.sh" "ntfy:notifico" -t template.toml -c "{username: 'USER1'}"
+
+== template.toml ==
+[parts]
+body = "Hello from Notifico! Username: {{username}}"
 ```
 
 ## Trigger an event on remote Notifico Ingest service

docs/plugins/core.md

@@ -17,6 +17,6 @@
 
 Where `RECIPIENT` is a recipient entity. See [Recipient](../recipient.md) for more info.
 
-## How this works under hood
+#### How this works under the hood
 The Pipeline is forked in the runtime, preserving the current pipeline context.
 The forked pipelines start from the following step. This step creates a pipeline for every recipient, resulting in `Recipients` pipelines.

docs/plugins/gotify.md

@@ -1,7 +1,3 @@
 # Gotify
 - **Contact:** not used
-- **Credential:** `gotify:API_URL`
-
-`API_URL` must adhere to the following format: `http(s)://GOTIFY_HOST:PORT/PATH/message?token=TOKEN`. For example: `gotify:http://localhost/message?token=AEC1G7nmPy1vHOy`
-
-**Channel:** `gotify`
+- **Credential:** `gotify:http(s)://<GOTIFY_HOST>:<PORT>/<PATH>?token=<TOKEN>` For example: `gotify:http://localhost/?token=AEC1G7nmPy1vHOy`

docs/plugins/ntfy.md

@@ -0,0 +1,10 @@
+# Ntfy
+- **Contact:** `ntfy:<TOPIC_NAME>`
+- **Credential:** `ntfy:<API_URL>`. To use ntfy.io, use `ntfy:https://ntfy.io`
+
+## Template parameters
+```toml
+[parts]
+body = "Template {{ parameter }}"
+title = "Title"
+```

docs/plugins/pushover.md

@@ -3,9 +3,10 @@
 - **Credential:** `pusoover:API_TOKEN`
 
 ## Template parameters
-```yaml
-body: "Template {{ parameter }}" # body of Pushover message
-title: "Title" # title, displayed in Push notification
+```toml
+[parts]
+body = "Template {{ parameter }}" # body of Pushover message
+title = "Title" # title, displayed in Push notification
 ```
 
 ## Steps

docs/plugins/smpp.md

@@ -1,5 +1,5 @@
 # SMPP (Short Message Peer-to-Peer Protocol)
-- **Contact:** `mobile_phone:PHONE`
+- **Contact:** `tel:PHONE`
 - **Credential:** `smpp:SYSTEM_ID:PASSWORD@HOST:PORT`
 
 SMPP is a protocol used by the telecommunications industry for exchanging SMS messages between Short Message Service Centers (SMSC) and External Short Messaging Entities (ESME).

docs/plugins/waba.md

@@ -1,3 +1,3 @@
 # WhatsApp Business
-- **Contact:** `mobile_phone:PHONE`
+- **Contact:** `tel:PHONE`
 - **Credential:** `waba:PHONE_ID:TOKEN`

mkdocs.yml

@@ -18,12 +18,13 @@ nav:
       - SMTP (Email): plugins/smtp.md
       - SMPP (SMS): plugins/smpp.md
       - plugins/gotify.md
+      - plugins/ntfy.md
       - plugins/pushover.md
       - plugins/slack.md
       - plugins/telegram.md
       - plugins/waba.md
   - API: api.md
-  - NotificoX: notificox.md
+  - notificox.md
 
 plugins:
   - swagger-ui-tag