@@ -77,9 +77,9 @@ can only be delivered to one method, and this method is configured globally with
77
77
[ ` CODER_NOTIFICATIONS_METHOD ` ] ( https://coder.com/docs/reference/cli/server#--notifications-method )
78
78
(default: ` smtp ` ).
79
79
80
- Enterprise customers can configured which method to use for each of the
81
- supported [ Events] ( #events ) ; see the [ Preferences] ( #preferences ) section below
82
- for more details.
80
+ Enterprise customers can configure which method to use for each of the supported
81
+ [ Events] ( #events ) ; see the [ Preferences] ( #preferences ) section below for more
82
+ details.
83
83
84
84
## SMTP (Email)
85
85
@@ -93,7 +93,7 @@ existing one.
93
93
| :------: | --------------------------------- | ------------------------------------- | ----------- | ----------------------------------------- | ------------- |
94
94
| ✔️ | ` --notifications-email-from ` | ` CODER_NOTIFICATIONS_EMAIL_FROM ` | ` string ` | The sender's address to use. | |
95
95
| ✔️ | ` --notifications-email-smarthost ` | ` CODER_NOTIFICATIONS_EMAIL_SMARTHOST ` | ` host:port ` | The SMTP relay to send messages through. | localhost:587 |
96
- | - ️ | ` --notifications-email-hello ` | ` CODER_NOTIFICATIONS_EMAIL_HELLO ` | ` string ` | The hostname identifying the SMTP server. | localhost |
96
+ | ✔ ️ | ` --notifications-email-hello ` | ` CODER_NOTIFICATIONS_EMAIL_HELLO ` | ` string ` | The hostname identifying the SMTP server. | localhost |
97
97
98
98
** Authentication Settings:**
99
99
@@ -252,6 +252,18 @@ To pause sending notifications, execute
252
252
To resume sending notifications, execute
253
253
[ ` coder notifications resume ` ] ( https://coder.com/docs/reference/cli/notifications_resume ) .
254
254
255
+ ## Troubleshooting
256
+
257
+ If notifications are not being delivered, use the following methods to
258
+ troubleshoot:
259
+
260
+ 1 . Ensure notifications are being added to the ` notification_messages ` table
261
+ 2 . Review any error messages in the ` status_reason ` column, should an error have
262
+ occurred
263
+ 3 . Review the logs (search for the term ` notifications ` ) for diagnostic
264
+ information<br > _ If you do not see any relevant logs, set
265
+ ` CODER_VERBOSE=true ` or ` --verbose ` to output debug logs_
266
+
255
267
## Internals
256
268
257
269
The notification system is built to operate concurrently in a single- or
@@ -288,5 +300,4 @@ messages._
288
300
- after ` CODER_NOTIFICATIONS_MAX_SEND_ATTEMPTS ` is exceeded, it transitions to
289
301
` permanent_failure `
290
302
291
- Diagnostic messages will be saved in the ` notification_messages ` table and will
292
- be logged, in the case of failure.
303
+ See [ Troubleshooting] ( #troubleshooting ) above for more details.
0 commit comments