Skip to content

Commit b94ef0e

Browse files
committed
docs: improve notifier configuration
Changes some misleading and vague formulations about internal apprise and supported services. Also fixes some typos and text format in the docs text.
1 parent 9e6eeea commit b94ef0e

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

docs/configuration.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3077,19 +3077,20 @@ domain: switch
30773077

30783078
### `[notifier]`
30793079

3080-
Enables the notification service. Multiple "notifiers" may be configured,
3081-
each with their own section, ie: `[notifier my_discord_server]`,
3080+
Enables the notification service. It is possible to configure multiple
3081+
notifiers with their own section, for example: `[notifier my_discord_server]`,
30823082
`[notifier my_phone]`.
30833083

3084-
All notifiers require an url for a service to be set up. Moonraker depends on
3085-
[Apprise](https://github.com/caronc/apprise) to emit notifications.
3086-
Available services and their corresponding at urls may be found on the
3087-
[Apprise Wiki](https://github.com/caronc/apprise/wiki).
3084+
All notifiers require an `url` for a notification service to be set up.
3085+
Moonraker uses the [Apprise](https://github.com/caronc/apprise) tool/package
3086+
locally to emit notifications. So Moonraker can send Notfictions to any
3087+
service that is [supported by Apprise](https://github.com/caronc/apprise#productivity-based-notifications).
30883088

3089+
#### Properties:
30893090
```ini {title="Moonraker Config Specification"}
30903091
# moonraker.conf
30913092

3092-
[notifier telegram]
3093+
[notifier my_telegram_notifier]
30933094
url: tgram://{bottoken}/{ChatID}
30943095
# The url for your notifier. This URL accepts Jinja2 templates,
30953096
# so you can use [secrets] if you want. This parameter must be
@@ -3142,7 +3143,7 @@ this section receives a list of "arguments" passed to the event. For
31423143
those familiar with Python this list is known as "variable arguments".
31433144
Currently the notifier only supports two kinds of events: those
31443145
triggered by a change in the job state and those triggered from a remote
3145-
method call frm a `gcode_macro`.
3146+
method call from a `gcode_macro`.
31463147

31473148
For `remote method` events the `event_args` field will always be
31483149
an empty list. For `job state` events the `event_args` field will
@@ -3184,8 +3185,8 @@ attach: http://192.168.1.100/webcam/?action=snapshot
31843185
```
31853186

31863187
#### Notifying from Klipper
3187-
It is possible to invoke your notifiers from the Klippy host, this can be done
3188-
with a gcode_macro, such as:
3188+
It is possible to invoke your notifiers from the Klippy host, this can be done with a `gcode_macro`, such as:
3189+
31893190
```ini {title="Klipper Config Example"}
31903191
# printer.cfg
31913192

0 commit comments

Comments
 (0)