Skip to content

Commit 58ac79a

Browse files
EdwardAngertClaude
and
Claude
committed
docs: update SMTP configuration in notifications docs
Fix inconsistency in documentation for SMTP settings between UI and docs: - Update email-smarthost description to include port format - Fix incorrect reference to CODER_NOTIFICATIONS_EMAIL_FORCE_TLS Fixes #16206 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent ac74c65 commit 58ac79a

File tree

1 file changed

+6
-6
lines changed
  • docs/admin/monitoring/notifications

1 file changed

+6
-6
lines changed

docs/admin/monitoring/notifications/index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,11 @@ existing one.
9595

9696
**Server Settings:**
9797

98-
| Required | CLI | Env | Type | Description | Default |
99-
|:--------:|---------------------|-------------------------|----------|-------------------------------------------|-----------|
100-
| ✔️ | `--email-from` | `CODER_EMAIL_FROM` | `string` | The sender's address to use. | |
101-
| ✔️ | `--email-smarthost` | `CODER_EMAIL_SMARTHOST` | `string` | The SMTP relay to send messages | |
102-
| ✔️ | `--email-hello` | `CODER_EMAIL_HELLO` | `string` | The hostname identifying the SMTP server. | localhost |
98+
| Required | CLI | Env | Type | Description | Default |
99+
|:--------:|---------------------|-------------------------|---------|-----------------------------------------------------------------|-----------|
100+
| ✔️ | `--email-from` | `CODER_EMAIL_FROM` | `string` | The sender's address to use. | |
101+
| ✔️ | `--email-smarthost` | `CODER_EMAIL_SMARTHOST` | `string` | The SMTP relay to send messages (format: `hostname:port`) | |
102+
| ✔️ | `--email-hello` | `CODER_EMAIL_HELLO` | `string` | The hostname identifying the SMTP server. | localhost |
103103

104104
**Authentication Settings:**
105105

@@ -115,7 +115,7 @@ existing one.
115115
| Required | CLI | Env | Type | Description | Default |
116116
|:--------:|-----------------------------|-------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
117117
| - | `--email-force-tls` | `CODER_EMAIL_FORCE_TLS` | `bool` | Force a TLS connection to the configured SMTP smarthost. If port 465 is used, TLS will be forced. See <https://datatracker.ietf.org/doc/html/rfc8314#section-3.3>. | false |
118-
| - | `--email-tls-starttls` | `CODER_EMAIL_TLS_STARTTLS` | `bool` | Enable STARTTLS to upgrade insecure SMTP connections using TLS. Ignored if `CODER_NOTIFICATIONS_EMAIL_FORCE_TLS` is set. | false |
118+
| - | `--email-tls-starttls` | `CODER_EMAIL_TLS_STARTTLS` | `bool` | Enable STARTTLS to upgrade insecure SMTP connections using TLS. Ignored if `CODER_EMAIL_FORCE_TLS` is set. | false |
119119
| - | `--email-tls-skip-verify` | `CODER_EMAIL_TLS_SKIPVERIFY` | `bool` | Skip verification of the target server's certificate (**insecure**). | false |
120120
| - | `--email-tls-server-name` | `CODER_EMAIL_TLS_SERVERNAME` | `string` | Server name to verify against the target certificate. | |
121121
| - | `--email-tls-cert-file` | `CODER_EMAIL_TLS_CERTFILE` | `string` | Certificate file to use. | |

0 commit comments

Comments
 (0)