Skip to content

Commit a59e970

Browse files
stirbydannykopping
authored andcommitted
minor link additions, started user preferences
1 parent ff2f78f commit a59e970

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

docs/admin/notifications.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ _These notifications are sent to users with **template admin** roles._
5959

6060
## Configuration
6161

62+
You can modify the notification delivery behavior using the following server flags.
63+
6264
| Required | CLI | Env | Type | Description | Default |
6365
|:--------:|-------------------------------------|-----------------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------|---------|
6466
| ✔️ | `--notifications-dispatch-timeout` | `CODER_NOTIFICATIONS_DISPATCH_TIMEOUT` | `duration` | How long to wait while a notification is being sent before giving up. | 1m |
@@ -206,7 +208,13 @@ The `payload` object has these keys:
206208
buttons
207209
- `labels`: dynamic map of zero or more string key-value pairs; these vary from event to event
208210

209-
## Preferences (enterprise)
211+
## User Preferences
212+
213+
All users have the option to opt-out of any notifications. Go to **Account** -> **Notifications** to turn notifications on or off. The delivery method for each notification is indicated on the right hand side of this table.
214+
215+
![User Notification Preferences](../images/user-notification-preferences.PNG)
216+
217+
## Delivery Preferences (enterprise)
210218

211219
Administrators can configure which delivery methods are used for each different [event type](#event-types).
212220

@@ -216,9 +224,11 @@ You can find this page under `https://$CODER_ACCESS_URL/deployment/notifications
216224

217225
## Stop sending notifications
218226

219-
To pause sending notifications, execute `coder notifications pause`.
227+
Administrators may wish to stop _all_ notifications across the deployment. We support a killswitch in the CLI for these cases.
228+
229+
To pause sending notifications, execute [`coder notifications pause`](https://coder.com/docs/reference/cli/notifications_pause).
220230

221-
To resume sending notifications, execute `coder notifications resume`.
231+
To resume sending notifications, execute [`coder notifications resume`](https://coder.com/docs/reference/cli/notifications_resume).
222232

223233
## Internals
224234

@@ -248,4 +258,4 @@ act as notifiers to process pending messages._
248258
be retried
249259
- after `CODER_NOTIFICATIONS_MAX_SEND_ATTEMPTS` is exceeded, it transitions to `permanent_failure`
250260

251-
Diagnostic messages will be saved in the `notification_messages` table and will be logged, in the case of failure.
261+
Diagnostic messages will be saved in the `notification_messages` table and will be logged, in the case of failure.
105 KB
Loading

0 commit comments

Comments
 (0)