Skip to content

Update SMTP Troubleshooting Page

Ben King requested to merge benjaminking-smtp-troubleshooting into master

What does this MR do?

A customer recently shared that in GitLab 15.11, their emails were not sending. They self-diagnosed and determined that both START TLS and SMTP TLS were enabled on their instance:

gitlab_rails['smtp_enable_starttls_auto'] = true
gitlab_rails['smtp_tls'] = true

In a recent merge request, introduced in GitLab 15.11, there is now a check against if both options have been enabled, and an error is returned accordingly.

This MR updates the SMTP troubleshooting section with the returned error message to provide an indication on why this has occurred, and what should be done to correct the behaviour.

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Stan Hu

Merge request reports