Skip to content

docs: add documentation for notifications feature #14478

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

Merged
merged 9 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
minor link additions, started user preferences
  • Loading branch information
stirby authored and dannykopping committed Aug 30, 2024
commit a59e97007624f8e06f5ecb4188a81d8e83aa117e
18 changes: 14 additions & 4 deletions docs/admin/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ _These notifications are sent to users with **template admin** roles._

## Configuration

You can modify the notification delivery behavior using the following server flags.

| Required | CLI | Env | Type | Description | Default |
|:--------:|-------------------------------------|-----------------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------|---------|
| ✔️ | `--notifications-dispatch-timeout` | `CODER_NOTIFICATIONS_DISPATCH_TIMEOUT` | `duration` | How long to wait while a notification is being sent before giving up. | 1m |
Expand Down Expand Up @@ -206,7 +208,13 @@ The `payload` object has these keys:
buttons
- `labels`: dynamic map of zero or more string key-value pairs; these vary from event to event

## Preferences (enterprise)
## User Preferences

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.

![User Notification Preferences](../images/user-notification-preferences.PNG)

## Delivery Preferences (enterprise)

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

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

## Stop sending notifications

To pause sending notifications, execute `coder notifications pause`.
Administrators may wish to stop _all_ notifications across the deployment. We support a killswitch in the CLI for these cases.

To pause sending notifications, execute [`coder notifications pause`](https://coder.com/docs/reference/cli/notifications_pause).

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

## Internals

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

Diagnostic messages will be saved in the `notification_messages` table and will be logged, in the case of failure.
Diagnostic messages will be saved in the `notification_messages` table and will be logged, in the case of failure.
Binary file added docs/images/user-notification-preferences.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.