Docs for new version

Author: GamePad64

.idea/docs.iml

@@ -12,11 +12,20 @@ All these variables can be passed to executables as command-line arguments (see
 | 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_CREDENTIALS_PATH |                  | Default: `/var/lib/notifico/credentials.toml`                                                                                                |
+| NOTIFICO_USERAPI_URL      | :material-check: | User-facing address for userapi service                                                                                                      | |
 
 ## Credentials
 
-Credentials are stored in TOML format. You can add as many configurations as you need for different services.
+Credentials in Notifico are set using environment variables. The format for setting credentials is as follows:
 
-See channels documentation for credential format.
+```shell
+NOTIFICO_CRED_<NAME>=<TRANSPORT>:<VALUE>
+```
+
+Where:
+
+- `<NAME>` is the name of the credential. This name is converted into lowercase.
+- `<TRANSPORT>` is the transport name
+- `<VALUE>` is the actual credential value
+
+For more detailed information about credential formats and their usage with specific plugins, please refer to the [Plugins](plugins/core.md) section of the documentation.

.idea/misc.xml

@@ -0,0 +1,35 @@
+# 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).
+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.
+
+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.
+
+Some arguments are formatted in [JSON5](https://json5.org/), so they can be entered without numerous escape sequences.
+
+## Send notification locally
+**Usage:**
+```shell
+notificox send --channel <CHANNEL> --template <TEMPLATE> <CREDENTIAL> [CONTACTS]...
+```
+
+**Where:**
+
+- CHANNEL: the channel of notification. You can find relevant channels in [PLugins](plugins/core.md) section of this documentation.
+- TEMPLATE: JSON5-formatted message template object. Template parameters are channel-specific.
+- CREDENTIAL: string-formatted transport credential
+- CONTACTS: zero or more contacts to send the message. Contact format is transport-specific. Some channels, 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.
+
+## Trigger an event on remote Notifico Ingest service
+**Usage:**
+```shell
+notificox send-event [OPTIONS] --ingest <INGEST> <EVENT> <CONTEXT>
+```

.idea/modules.xml

@@ -1,6 +1,7 @@
 # Core plugin
 
-## Step: `core.set_recipients`
+## Steps
+### Step: `core.set_recipients`
 
 ```json
 {
@@ -16,7 +17,6 @@
 
 Where `RECIPIENT` is a recipient entity. See [Recipient](../recipient.md) for more info.
 
-### How this works under hood:
+## How this works under 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 contact, matching current
-pipeline's channel for every recipient, resulting in `Recipients * Contacts` pipelines.
+The forked pipelines start from the following step. This step creates a pipeline for every recipient, resulting in `Recipients` pipelines.

.idea/vcs.xml

@@ -1,61 +1,26 @@
 # Pushover
 
-**Channel identifier:** `pushover`
+**Contact:** `pushover:USER_KEY`
 
-## Quick example
-`POST /api/v1/send`
-```json
-{
-    "event": "YOUR_EVENT_NAME",
-    "recipients": [
-        {
-            "id": "3766b9e9-a700-4c75-a9c9-88117af11767",
-            "contacts": [
-                {
-                    "type": "pushover",
-                    "user": "RECIPIENT_USER_KEY"
-                }
-            ]
-        }
-    ],
-    "context": {
-        "beans_count": 4815162342
-    }
-}
-```
+**Credential:** `pusoover:API_TOKEN`
 
-## Step: `pushover.send`
-```json
-{
-  "step": "pushover.send",
-  "credential": "CREDENTIAL_NAME"
-}
-```
+**Channel:** `pushover`
 
 ## Template parameters
-- `text` parameter defines the body of Pushover message.
-- `title` defines the title, displayed in Push notification.
-```toml
-text = "You have {{ beans_count }} magic beans"
-title = "Hello!"
+```yaml
+body: "Template {{ parameter }}" # body of Pushover message
+title: "Title" # title, displayed in Push notification
 ```
 
-## Contact
-[Recipient](../recipient.md) Contact format for Pushover integration:
+## Steps
+### Step: `pushover.send`
 ```json
 {
-  "type": "pushover",
-  "user": "USER_KEY"
+  "step": "pushover.send",
+  "credential": "CREDENTIAL_NAME"
 }
 ```
 
-## Credentials
+## Connecting to Pushover
 To configure your Pushover account, you have to create a new application [here](https://pushover.net/apps/build).
-You will get "API Token", that you can add to your `credentials.toml` file:
-
-```toml
-[pushover.CREDENTIAL_NAME]
-token = "YOUR_PUSHOVER_TOKEN"
-```
-
-Replace `CREDENTIAL_NAME` with a credential name, that will be used for referencing this credential in pipelines (see above).
+You will get "API Token", that you use in credential.

docs/configuration.md

@@ -1,6 +1,10 @@
 # Slack
 
-**Channel identifier:** `slack`
+**Contact:** `slack:CHANNEL_ID`
+
+**Credential:** `slack:API_TOKEN`
+
+**Channel:** `slack`
 
 ## Step: `slack.send`
 ```json

docs/notificox.md

@@ -1,19 +1,13 @@
 # SMPP (Short Message Peer-to-Peer Protocol)
 
-**Channel identifier:** `sms`
+**Contact:** `mobile_phone:PHONE`
 
-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).
+**Credential:** `smpp:SYSTEM_ID:PASSWORD@HOST:PORT`
 
-Many SMS Center services allow SMPP protocol for sending SMS.
+**Channel:** `sms`
 
-To configure an SMPP server, add the following section to your `credentials.toml` file:
+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).
 
-```toml
-[smpp.<NAME>]
-host = "smpp.example.com"
-port = 2775
-username = "your_username"
-password = "your_password"
-```
+Many SMS Center services allow SMPP protocol for sending SMS.
 
 Note: We don't support TLS for SMPP right now. This will be added in future releases.