Skip to content

Commit 841f1d6

Browse files
authored
Merge pull request #119 from pluisol/docs/add-pushover-notifications
docs: add Pushover notification provider
2 parents 0369f85 + 523d560 commit 841f1d6

File tree

4 files changed

+46
-2
lines changed

4 files changed

+46
-2
lines changed

apps/docs/content/docs/api/reference-notification.mdx

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,15 @@ _openapi:
7878
- depth: 2
7979
title: Notification test Lark Connection
8080
url: '#notification-test-lark-connection'
81+
- depth: 2
82+
title: Notification create Pushover
83+
url: '#notification-create-pushover'
84+
- depth: 2
85+
title: Notification update Pushover
86+
url: '#notification-update-pushover'
87+
- depth: 2
88+
title: Notification test Pushover Connection
89+
url: '#notification-test-pushover-connection'
8190
- depth: 2
8291
title: Notification get Email Providers
8392
url: '#notification-get-email-providers'
@@ -133,9 +142,15 @@ _openapi:
133142
id: notification-update-lark
134143
- content: Notification test Lark Connection
135144
id: notification-test-lark-connection
145+
- content: Notification create Pushover
146+
id: notification-create-pushover
147+
- content: Notification update Pushover
148+
id: notification-update-pushover
149+
- content: Notification test Pushover Connection
150+
id: notification-test-pushover-connection
136151
- content: Notification get Email Providers
137152
id: notification-get-email-providers
138153
contents: []
139154
---
140155

141-
<APIPage document={"./public/openapi.json"} operations={[{"method":"post","path":"/notification.createSlack"},{"method":"post","path":"/notification.updateSlack"},{"method":"post","path":"/notification.testSlackConnection"},{"method":"post","path":"/notification.createTelegram"},{"method":"post","path":"/notification.updateTelegram"},{"method":"post","path":"/notification.testTelegramConnection"},{"method":"post","path":"/notification.createDiscord"},{"method":"post","path":"/notification.updateDiscord"},{"method":"post","path":"/notification.testDiscordConnection"},{"method":"post","path":"/notification.createEmail"},{"method":"post","path":"/notification.updateEmail"},{"method":"post","path":"/notification.testEmailConnection"},{"method":"post","path":"/notification.remove"},{"method":"get","path":"/notification.one"},{"method":"get","path":"/notification.all"},{"method":"post","path":"/notification.receiveNotification"},{"method":"post","path":"/notification.createGotify"},{"method":"post","path":"/notification.updateGotify"},{"method":"post","path":"/notification.testGotifyConnection"},{"method":"post","path":"/notification.createNtfy"},{"method":"post","path":"/notification.updateNtfy"},{"method":"post","path":"/notification.testNtfyConnection"},{"method":"post","path":"/notification.createLark"},{"method":"post","path":"/notification.updateLark"},{"method":"post","path":"/notification.testLarkConnection"},{"method":"get","path":"/notification.getEmailProviders"}]} hasHead={true} />
156+
<APIPage document={"./public/openapi.json"} operations={[{"method":"post","path":"/notification.createSlack"},{"method":"post","path":"/notification.updateSlack"},{"method":"post","path":"/notification.testSlackConnection"},{"method":"post","path":"/notification.createTelegram"},{"method":"post","path":"/notification.updateTelegram"},{"method":"post","path":"/notification.testTelegramConnection"},{"method":"post","path":"/notification.createDiscord"},{"method":"post","path":"/notification.updateDiscord"},{"method":"post","path":"/notification.testDiscordConnection"},{"method":"post","path":"/notification.createEmail"},{"method":"post","path":"/notification.updateEmail"},{"method":"post","path":"/notification.testEmailConnection"},{"method":"post","path":"/notification.remove"},{"method":"get","path":"/notification.one"},{"method":"get","path":"/notification.all"},{"method":"post","path":"/notification.receiveNotification"},{"method":"post","path":"/notification.createGotify"},{"method":"post","path":"/notification.updateGotify"},{"method":"post","path":"/notification.testGotifyConnection"},{"method":"post","path":"/notification.createNtfy"},{"method":"post","path":"/notification.updateNtfy"},{"method":"post","path":"/notification.testNtfyConnection"},{"method":"post","path":"/notification.createLark"},{"method":"post","path":"/notification.updateLark"},{"method":"post","path":"/notification.testLarkConnection"},{"method":"post","path":"/notification.createPushover"},{"method":"post","path":"/notification.updatePushover"},{"method":"post","path":"/notification.testPushoverConnection"},{"method":"get","path":"/notification.getEmailProviders"}]} hasHead={true} />

apps/docs/content/docs/core/(Notifications)/meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"email",
1010
"gotify",
1111
"ntfy",
12+
"pushover",
1213
"webhook"
1314
]
1415
}

apps/docs/content/docs/core/(Notifications)/overview.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,6 @@ Dokploy supports the following notification providers:
2929
5. **Email**: Email is a popular method for sending messages to a group of recipients.
3030
6. **Gotify**: Gotify is a self-hosted push notification service.
3131
7. **Ntfy**: Ntfy is a simple HTTP-based pub-sub notification service.
32-
8. **Webhook**: Webhook is a generic webhook notification service.
32+
8. **Pushover**: Pushover is a service for sending real-time notifications to Android, iOS, and desktop devices.
33+
9. **Webhook**: Webhook is a generic webhook notification service.
3334

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Pushover
3+
description: 'Configure Pushover notifications for your applications.'
4+
---
5+
6+
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.
7+
8+
## Pushover Notifications
9+
10+
To start receiving Pushover notifications, you need to fill the form with the following details:
11+
12+
- **Name**: Enter any name you want.
13+
- **User Key**: Enter your Pushover user key. eg. `ub3de9kl2q...`
14+
- **API Token**: Enter your Pushover application API token. eg. `a3d9k2q7m4...`
15+
- **Priority**: Enter the priority of the notification (-2 to 2, default: 0).
16+
- `-2`: Lowest priority (no sound/vibration)
17+
- `-1`: Low priority (no sound/vibration)
18+
- `0`: Normal priority (default)
19+
- `1`: High priority (bypasses quiet hours)
20+
- `2`: Emergency priority (requires acknowledgment)
21+
22+
For emergency priority (2), you must also provide:
23+
24+
- **Retry**: How often (in seconds) Pushover will retry the notification. Minimum 30 seconds.
25+
- **Expire**: How long (in seconds) to keep retrying. Maximum 10800 seconds (3 hours).
26+
27+
To setup the Pushover notifications, you can read the [Pushover Documentation](https://pushover.net/api).

0 commit comments

Comments
 (0)