mirrors/homebox
1
0
Fork 0
mirror of https://github.com/sysadminsmedia/homebox.git synced 2025-12-21 21:33:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add additional documentation for Notifiers (#530)

Browse Source 
* Add additional documentation for Notifiers

When I first set up the notifiers, I felt like the documentation was pretty light on how to do this. 

I'd like to submit a few more PRs to outline a couple basic examples on this page (or a separate page specific for notifications) in addition to elaborating more on how this feature works. It's super flexible, and I love that!

Nevertheless, I think it would be more accessible to outline a few examples on what this ends up entailing.

* User general/latest shoutrrr URL without hardcoded version
This commit is contained in:
kylehakala
2025-02-16 15:58:10 -06:00
committed by GitHub
parent c4edb81fdd
commit 8e46553a0d
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/en/tips-tricks.md
View File

@@ -55,11 +55,15 @@ In version 0.8.0 We've added a custom label generation. On the tools page, there
:label: v0.9.0 :label: v0.9.0
Homebox uses [shoutrrr](https://containrrr.dev/shoutrrr/0.7/) to send notifications. This allows you to send notifications to a variety of services. On your profile page, you can add notification URLs to your profile which will be used to send notifications when a maintenance event is scheduled. Homebox uses [shoutrrr](https://containrrr.dev/shoutrrr/) to send notifications. This allows you to send notifications to a variety of services including Discord, Slack, IFTTT, generic webhooks, and SMTP-based email.
On your profile page, you can create a new **Notifier** using a supported shoutrrr notification URL to send notifications when a maintenance event is scheduled.
For the full list of services and how to configure the service URL, refer to the [Services Overview](https://containrrr.dev/shoutrrr/services/overview/) in shoutrrr's documentation.
**Notifications are sent on the day the maintenance is scheduled at or around 8am.** **Notifications are sent on the day the maintenance is scheduled at or around 8am.**
As of `v0.9.0` we have limited support for complex scheduling of maintenance events. If you have requests for extended functionality, please open an issue on GitHub or reach out on Discord. We're still gauging the demand for this feature. As of `v0.9.0`, there is limited support for complex scheduling of maintenance events. If you have requests for extended functionality, please [open an issue on GitHub](https://github.com/sysadminsmedia/homebox/issues/new?template=feature_request.yml) or reach out on Discord. We're still gauging the demand for this feature.
## Custom Currencies ## Custom Currencies