diff --git a/apps/docs/content/docs/api/reference-notification.mdx b/apps/docs/content/docs/api/reference-notification.mdx index d7901b2..e2a3100 100644 --- a/apps/docs/content/docs/api/reference-notification.mdx +++ b/apps/docs/content/docs/api/reference-notification.mdx @@ -78,6 +78,15 @@ _openapi: - depth: 2 title: Notification test Lark Connection url: '#notification-test-lark-connection' + - depth: 2 + title: Notification create Pushover + url: '#notification-create-pushover' + - depth: 2 + title: Notification update Pushover + url: '#notification-update-pushover' + - depth: 2 + title: Notification test Pushover Connection + url: '#notification-test-pushover-connection' - depth: 2 title: Notification get Email Providers url: '#notification-get-email-providers' @@ -133,9 +142,15 @@ _openapi: id: notification-update-lark - content: Notification test Lark Connection id: notification-test-lark-connection + - content: Notification create Pushover + id: notification-create-pushover + - content: Notification update Pushover + id: notification-update-pushover + - content: Notification test Pushover Connection + id: notification-test-pushover-connection - content: Notification get Email Providers id: notification-get-email-providers contents: [] --- - \ No newline at end of file + \ No newline at end of file diff --git a/apps/docs/content/docs/core/(Notifications)/meta.json b/apps/docs/content/docs/core/(Notifications)/meta.json index 4c8db4f..6da7417 100644 --- a/apps/docs/content/docs/core/(Notifications)/meta.json +++ b/apps/docs/content/docs/core/(Notifications)/meta.json @@ -9,6 +9,7 @@ "email", "gotify", "ntfy", + "pushover", "webhook" ] } diff --git a/apps/docs/content/docs/core/(Notifications)/overview.mdx b/apps/docs/content/docs/core/(Notifications)/overview.mdx index df95094..8e8f41b 100644 --- a/apps/docs/content/docs/core/(Notifications)/overview.mdx +++ b/apps/docs/content/docs/core/(Notifications)/overview.mdx @@ -29,5 +29,6 @@ Dokploy supports the following notification providers: 5. **Email**: Email is a popular method for sending messages to a group of recipients. 6. **Gotify**: Gotify is a self-hosted push notification service. 7. **Ntfy**: Ntfy is a simple HTTP-based pub-sub notification service. -8. **Webhook**: Webhook is a generic webhook notification service. +8. **Pushover**: Pushover is a service for sending real-time notifications to Android, iOS, and desktop devices. +9. **Webhook**: Webhook is a generic webhook notification service. diff --git a/apps/docs/content/docs/core/(Notifications)/pushover.mdx b/apps/docs/content/docs/core/(Notifications)/pushover.mdx new file mode 100644 index 0000000..eb603f0 --- /dev/null +++ b/apps/docs/content/docs/core/(Notifications)/pushover.mdx @@ -0,0 +1,27 @@ +--- +title: Pushover +description: 'Configure Pushover notifications for your applications.' +--- + +Pushover notifications are a great way to stay up to date with important events in your Dokploy panel. You can choose to receive notifications for specific events or all events. + +## Pushover Notifications + +To start receiving Pushover notifications, you need to fill the form with the following details: + +- **Name**: Enter any name you want. +- **User Key**: Enter your Pushover user key. eg. `ub3de9kl2q...` +- **API Token**: Enter your Pushover application API token. eg. `a3d9k2q7m4...` +- **Priority**: Enter the priority of the notification (-2 to 2, default: 0). + - `-2`: Lowest priority (no sound/vibration) + - `-1`: Low priority (no sound/vibration) + - `0`: Normal priority (default) + - `1`: High priority (bypasses quiet hours) + - `2`: Emergency priority (requires acknowledgment) + +For emergency priority (2), you must also provide: + +- **Retry**: How often (in seconds) Pushover will retry the notification. Minimum 30 seconds. +- **Expire**: How long (in seconds) to keep retrying. Maximum 10800 seconds (3 hours). + +To setup the Pushover notifications, you can read the [Pushover Documentation](https://pushover.net/api).