Skip to content

docs: update SMTP configuration in notifications docs #17161

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.

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

Conversation

EdwardAngert
Copy link
Contributor

@EdwardAngert EdwardAngert commented Mar 28, 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

🤖 Generated with Claude Code

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 EdwardAngert added the docs Area: coder.com/docs label Mar 28, 2025
@EdwardAngert EdwardAngert self-assigned this Mar 28, 2025
@EdwardAngert EdwardAngert requested review from matifali and stirby March 28, 2025 21:07
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@EdwardAngert EdwardAngert merged commit 900e125 into main Apr 1, 2025
32 checks passed
@EdwardAngert EdwardAngert deleted the 16206-smtp-required-components branch April 1, 2025 18:44
@github-actions github-actions bot locked and limited conversation to collaborators Apr 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Area: coder.com/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Match the SMTP Required components between the UI and the formal documents
2 participants