Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit0125ff4

Browse files
authored
docs: add new workspace notifications dashboard and config (#16548)
closes#16511 [preview](https://coder.com/docs/@16511-dashboard-vscode-notif/admin/monitoring/notifications)(beta tag is removed in#17096)---------Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent2efb808 commit0125ff4

File tree

4 files changed

+53
-33
lines changed

4 files changed

+53
-33
lines changed

‎docs/admin/monitoring/notifications/index.md

Lines changed: 40 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -14,56 +14,75 @@ user(s) of the event.
1414

1515
Coder supports the following list of events:
1616

17-
###Workspace Events
17+
###Template Events
1818

19-
These notifications are sent tothe workspace owner:
19+
These notifications are sent tousers with**template admin** roles:
2020

21-
- Workspace created
22-
- Workspace deleted
23-
- Workspace manual build failure
24-
- Workspace automatic build failure
25-
- Workspace manually updated
26-
- Workspace automatically updated
27-
- Workspace marked as dormant
28-
- Workspace marked for deletion
21+
- Report: Workspace builds failed for template
22+
- This notification is delivered as part of a weekly cron job and summarizes
23+
the failed builds for a given template.
24+
- Template deleted
25+
- Template deprecated
2926

3027
###User Events
3128

3229
These notifications are sent to users with**owner** and**user admin** roles:
3330

31+
- User account activated
3432
- User account created
3533
- User account deleted
3634
- User account suspended
37-
- User account activated
3835

3936
These notifications are sent to users themselves:
4037

4138
- User account suspended
4239
- User account activated
4340
- User password reset (One-time passcode)
4441

45-
###Template Events
42+
###Workspace Events
4643

47-
These notifications are sent tousers with**template admin** roles:
44+
These notifications are sent tothe workspace owner:
4845

49-
- Template deleted
50-
- Template deprecated
46+
- Workspace automatic build failure
47+
- Workspace created
48+
- Workspace deleted
49+
- Workspace manual build failure
50+
- Workspace manually updated
51+
- Workspace marked as dormant
52+
- Workspace marked for deletion
5153
- Out of memory (OOM) / Out of disk (OOD)
52-
-[Configure](#configure-oomood-notifications) in the template`main.tf`.
53-
- Report: Workspace builds failed for template
54-
- This notification is delivered as part of a weekly cron job and summarizes
55-
the failed builds for a given template.
54+
- Template admins can[configure OOM/OOD](#configure-oomood-notifications) notifications in the template`main.tf`.
55+
- Workspace automatically updated
56+
57+
##Delivery Methods
58+
59+
Notifications can be delivered through the Coder dashboard Inbox and by SMTP or webhook.
60+
OOM/OOD notifications can be delivered to users in VS Code.
61+
62+
You can configure:
63+
64+
- SMTP or webhooks globally with
65+
[`CODER_NOTIFICATIONS_METHOD`](../../../reference/cli/server.md#--notifications-method)
66+
(default:`smtp`).
67+
- Coder dashboard Inbox with
68+
[`CODER_NOTIFICATIONS_INBOX_ENABLED`](../../../reference/cli/server.md#--notifications-inbox-enabled)
69+
(default:`true`).
70+
71+
Premium customers can configure which method to use for each of the supported
72+
[Events](#workspace-events).
73+
See the[Preferences](#delivery-preferences) section for more details.
5674

5775
##Configuration
5876

59-
You can modify the notification delivery behaviorusing the following server
60-
flags.
77+
You can modify the notification delivery behaviorin your Coder deployment's
78+
`https://coder.example.com/settings/notifications`, or with the following server flags:
6179

6280
| Required| CLI| Env| Type| Description| Default|
6381
|:--------:|-------------------------------------|-----------------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------|---------|
6482
| ✔️|`--notifications-dispatch-timeout`|`CODER_NOTIFICATIONS_DISPATCH_TIMEOUT`|`duration`| How long to wait while a notification is being sent before giving up.| 1m|
6583
| ✔️|`--notifications-method`|`CODER_NOTIFICATIONS_METHOD`|`string`| Which delivery method to use (available options: 'smtp', 'webhook'). See[Delivery Methods](#delivery-methods) below.| smtp|
6684
| -️|`--notifications-max-send-attempts`|`CODER_NOTIFICATIONS_MAX_SEND_ATTEMPTS`|`int`| The upper limit of attempts to send a notification.| 5|
85+
| -️|`--notifications-inbox-enabled`|`CODER_NOTIFICATIONS_INBOX_ENABLED`|`bool`| Enable or disable inbox notifications in the Coder dashboard.| true|
6786

6887
###Configure OOM/OOD notifications
6988

@@ -75,18 +94,6 @@ This can help prevent agent disconnects due to OOM/OOD issues.
7594
To enable OOM/OOD notifications on a template, follow the steps in the
7695
[resource monitoring guide](../../templates/extending-templates/resource-monitoring.md).
7796

78-
##Delivery Methods
79-
80-
Notifications can currently be delivered by either SMTP or webhook. Each message
81-
can only be delivered to one method, and this method is configured globally with
82-
[`CODER_NOTIFICATIONS_METHOD`](../../../reference/cli/server.md#--notifications-method)
83-
(default:`smtp`). When there are no delivery methods configured, notifications
84-
will be disabled.
85-
86-
Premium customers can configure which method to use for each of the supported
87-
[Events](#workspace-events); see the[Preferences](#delivery-preferences)
88-
section below for more details.
89-
9097
##SMTP (Email)
9198

9299
Use the`smtp` method to deliver notifications by email to your users. Coder

‎docs/images/icons/inbox-in.svg

Lines changed: 6 additions & 0 deletions
Loading

‎docs/manifest.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,12 @@
194194
"path":"./user-guides/workspace-management.md",
195195
"icon_path":"./images/icons/generic.svg"
196196
},
197+
{
198+
"title":"Workspace Notifications",
199+
"description":"Manage workspace notifications",
200+
"path":"./user-guides/inbox/index.md",
201+
"icon_path":"./images/icons/inbox-in.svg"
202+
},
197203
{
198204
"title":"Workspace Scheduling",
199205
"description":"Cost control with workspace schedules",

‎docs/user-guides/inbox/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
#Workspace notifications

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp