8000 docs: add new workspace notifications dashboard and config by EdwardAngert · Pull Request #16548 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

docs: add new workspace notifications dashboard and config #16548

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.

Sign up for GitHub

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 8 commits into from
Apr 2, 2025
Merged

docs: add new workspace notifications dashboard and config #16548

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f8e69e7
init inbox docs
EdwardAngert Feb 12, 2025
bb1f593
update (placeholder) icon
EdwardAngert Feb 12, 2025
78119e2
Merge remote-tracking branch 'origin/main' into 16511-dashboard-vscod…
EdwardAngert Mar 25, 2025
17233c4
Merge remote-tracking branch 'origin/main' into 16511-dashboard-vscod…
EdwardAngert Apr 1, 2025
cf57208
update/reorg notifications
EdwardAngert Apr 1, 2025
ce8e237
use /settings/notifications
EdwardAngert Apr 1, 2025
e559d25
add coder_notifications_inbox_enabled
EdwardAngert Apr 1, 2025
6e5f6da
Merge remote-tracking branch 'origin/main' into 16511-dashboard-vscod…
EdwardAngert Apr 1, 2025
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
add coder_notifications_inbox_enabled
  • Loading branch information
@EdwardAngert
EdwardAngert committed Apr 1, 2025
commit e559d257942563350c20c17919d1e441ccc2aff9
11 changes: 8 additions & 3 deletions docs/admin/monitoring/notifications/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,17 @@ These notifications are sent to the workspace owner:

## Delivery Methods

Notifications can be delivered in the Coder dashboard and by SMTP or webhook.
Notifications can be delivered through the Coder dashboard Inbox and by SMTP or webhook.
OOM/OOD notifications can be delivered to users in VS Code.

You can choose SMTP or webhook globally with
You can configure:

- SMTP or webhooks globally with
[`CODER_NOTIFICATIONS_METHOD`](../../../reference/cli/server.md#--notifications-method)
(default: `smtp`).
When there are no delivery methods configured, notifications are disabled.
- Coder dashboard Inbox with
[`CODER_NOTIFICATIONS_INBOX_ENABLED`](../../../reference/cli/server.md#--notifications-inbox-enabled)
(default: `true`).

Premium customers can configure which method to use for each of the supported
[Events](#workspace-events).
Expand All @@ -78,6 +82,7 @@ You can modify the notification delivery behavior in your Coder deployment's
| ✔️ | `--notifications-dispatch-timeout` | `CODER_NOTIFICATIONS_DISPATCH_TIMEOUT` | `duration` | How long to wait while a notification is being sent before giving up. | 1m |
| ✔️ | `--notifications-method` | `CODER_NOTIFICATIONS_METHOD` | `string` | Which delivery method to use (available options: 'smtp', 'webhook'). See [Delivery Methods](#delivery-methods) below. | smtp |
| -️ | `--notifications-max-send-attempts` | `CODER_NOTIFICATIONS_MAX_SEND_ATTEMPTS` | `int` | The upper limit of attempts to send a notification. | 5 |
| -️ | `--notifications-inbox-enabled` | `CODER_NOTIFICATIONS_INBOX_ENABLED` | `bool` | Enable or disable inbox notifications in the Coder dashboard. | true |

### Configure OOM/OOD notifications

Expand Down
Loading
0