-
-
Notifications
You must be signed in to change notification settings - Fork 47
feat: add ntfy integration #2900
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
base: dev
Are you sure you want to change the base?
Conversation
Here's the code health analysis summary for commits Analysis Summary
|
Don't forget to mark the PR as ready for review when you're done ;) |
My config for the screenshot (left to right, top to bottom): Integrations: Widgets:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for this contribution. Let me know if you have any questions
packages/integrations/src/interfaces/notifications/notification.ts
Outdated
Show resolved
Hide resolved
packages/integrations/src/interfaces/notifications/notifications-integration.ts
Outdated
Show resolved
Hide resolved
|
||
export abstract class NotificationsIntegration extends Integration { | ||
/** Get current notification list. */ | ||
public abstract getNotificationsAsync(topics: string[]): Promise<Notification[]>; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering whether we could abstract away the topic. Can we possibly add this in the integration options instead of the widget options? Then it would be abstracted away and you could remove this parameter.
We already do this for Proxmox.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should I do this with a new category (similar to 'realm' for proxmox)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes.
Hi @itzTheMeow , do you need further input from us or what is the status of this? |
Hey, currently on vacation so I haven't had time to work on this. It's still in my plans. |
No worries, thanks for the update. Enjoy the vacation |
Homarr
Thank you for your contribution. Please ensure that your pull request meets the following pull request:
pnpm build
, autofix withpnpm format:fix
)dev
branchx
,y
,i
or any abbrevation)WORK IN PROGRESS
Adds widget to show ntfy notifications.
notifications
.Preview:

I attempted to make the
notifications
widget accessible to other notification services such as gotify, however not all services use topics to define the notification locations so it may need reworking if another service is to be supported.The ntfy integration supports authentication or no authentication. To test the URL can be set to
https://ntfy.sh
and access token left unset. Some example topics to subscribe to:mytopic
,test
To publish messages to these topics, use https://ntfy.sh/mytopic
Additional notes:
I set the cron timer for these to 30 seconds to avoid spamming the API with requests every 5 seconds (was getting ratelimited).
The integrations selector allows for multiple ntfy integrations to be selected for the same widget. The selected topics are shared between both instances so most likely one or the other will not have a specified topic.