Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a Matrix example to notifications.md #1690

Closed
wants to merge 2 commits into from

Conversation

Krafting
Copy link

@Krafting Krafting commented Jul 8, 2023

Why: I spent a few hours to get it setup right as I didn't understand what shoutrr was.

This might help others as well in the future. Example: https://lemmy.world/comment/928893

Why: I spent a few hours to get it setup right as I didn't understand what shoutrr was. This might help others as well in the future. Example: https://lemmy.world/comment/928893
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Congratulations on opening your first pull request! We'll get back to you as soon as possible. In the meantime, please make sure you've updated the documentation to reflect your changes and have added test automation as needed. Thanks! 🙏🏼

@GridexX
Copy link
Contributor

GridexX commented Jul 26, 2023

Indeed it could helps, 👍 For the contribution

@piksel
Copy link
Member

piksel commented Jul 27, 2023

Hm, it doesn't seem like that template is anything matrix-specific? I think the main issue here is that it's not obvious from the docs that matrix support is built into watchtower (through shoutrrr). I guess it's still the legacy notification options that give that impression...

@Krafting
Copy link
Author

Hm, it doesn't seem like that template is anything matrix-specific? I think the main issue here is that it's not obvious from the docs that matrix support is built into watchtower (through shoutrrr). I guess it's still the legacy notification options that give that impression...

It's indeed a bit confusing.

Also, the WATCHTOWER_NOTIFICATION_URL for matrix can be very weird, as you have the server url, the room id (which also contains the server URL) I had to do multiple attempt before finding the correct format, I just think this could really help others as well.

@piksel
Copy link
Member

piksel commented Jul 28, 2023

The problem is that we should either include docs for all services, or none. Just having a section for matrix only makes the problem worse for the other services. We could have a list of supported services (which each link to the shoutrrr service docs). That would help with searchability as well.
The server for the rooms is not required if it's the same as the "host" server (if I recall correctly). But otherwise I think any improvements to the docs should be redirected to shoutrrr (which I happen to be maintaining as well 😁).

@simskij
Copy link
Member

simskij commented Jul 28, 2023

I agree. We can definitely make improvements to https://github.com/canonical/shoutrrr, but I don't think it belongs here in watchtower.

@simskij simskij closed this Jul 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants