Match the SMTP Required components between the UI and the formal documents #16206
Assignees
Labels
docs
Area: coder.com/docs
Comments
EdwardAngert
added a commit
that referenced
this issue
Mar 28, 2025
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>
EdwardAngert
added a commit
that referenced
this issue
Apr 1, 2025
## Issue Closes #16206 (thanks @bjornrobertsson - not sure why I can't tag you as a reviewer) Mismatch between the SMTP configuration UI and the documentation. ## Verification Claude verified this issue by examining: 1. The current SMTP configuration code in the codebase 2. The CLI help documentation for the server command 3. The examples provided in the notifications documentation The issue was confirmed by finding: - A reference to a deprecated variable `CODER_NOTIFICATIONS_EMAIL_FORCE_TLS` instead of the current `CODER_EMAIL_FORCE_TLS` - Missing information about the port format required for the SMTP smarthost ## Changes made 1. Updated the `--email-smarthost` description to clarify that the format should include both hostname and port: `(format: hostname:port)` 2. Fixed the reference to the TLS environment variable in the STARTTLS description, replacing the deprecated `CODER_NOTIFICATIONS_EMAIL_FORCE_TLS` with the correct `CODER_EMAIL_FORCE_TLS` ## Additional information The Gmail and Outlook examples in the documentation already correctly show the port included in the smarthost configuration, but the main description table needed to be updated to explicitly mention this requirement. [preview](https://coder.com/docs/@16206-smtp-required-components/admin/monitoring/notifications) <sub>🤖 Generated with [Claude Code](https://claude.ai/code)</sub> --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
EdwardAngert
added a commit
that referenced
this issue
Apr 1, 2025
## Issue Closes #16206 (thanks @bjornrobertsson - not sure why I can't tag you as a reviewer) Mismatch between the SMTP configuration UI and the documentation. ## Verification Claude verified this issue by examining: 1. The current SMTP configuration code in the codebase 2. The CLI help documentation for the server command 3. The examples provided in the notifications documentation The issue was confirmed by finding: - A reference to a deprecated variable `CODER_NOTIFICATIONS_EMAIL_FORCE_TLS` instead of the current `CODER_EMAIL_FORCE_TLS` - Missing information about the port format required for the SMTP smarthost ## Changes made 1. Updated the `--email-smarthost` description to clarify that the format should include both hostname and port: `(format: hostname:port)` 2. Fixed the reference to the TLS environment variable in the STARTTLS description, replacing the deprecated `CODER_NOTIFICATIONS_EMAIL_FORCE_TLS` with the correct `CODER_EMAIL_FORCE_TLS` ## Additional information The Gmail and Outlook examples in the documentation already correctly show the port included in the smarthost configuration, but the main description table needed to be updated to explicitly mention this requirement. [preview](https://coder.com/docs/@16206-smtp-required-components/admin/monitoring/notifications) <sub>🤖 Generated with [Claude Code](https://claude.ai/code)</sub> --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The formal documents for the SMTP setup:
https://coder.com/docs/@v2.18.2/admin/monitoring/notifications#smtp-email
The UI's page: /deployment/notifications?tab=settings
It would be beneficial to see closer alignment in which settings are Required.
The UI's version may also benefit the SMARTHOST to be updated from CODER_NOTIFICATIONS_EMAIL_FORCE_TLS to CODER_EMAIL_SMARTHOST (Unless this is fixed in 2.18.3).
Also, the UI version could benefit with CODER_EMAIL_SMARTHOST:PORT (since the PORT is also Required)
The text was updated successfully, but these errors were encountered: