GitLab邮件服务配置与错误排查

前言
GitLab可通过配置SMTP服务来发送通知邮件，配置后需要手动验证是否配置成功，并进行必要排查。本文记录一些快速的配置方法和排查手段。

一、配置SMTP服务器信息
GitLab主要配置存放于/etc/gitlab/gitlab.rb（如果是容器部署请注意持久化文件路径）

我们对此配置文件进行编辑：

nano gitlab.rb
新增如下配置行：

gitlab_rails['smtp_enable'] = true
gitlab_rails['smtp_address'] = "smtp.server"
gitlab_rails['smtp_user_name'] = "smtp user"
gitlab_rails['smtp_password'] = "smtp password"
gitlab_rails['smtp_domain'] = "example.com"
gitlab_rails['smtp_authentication'] = "login"
gitlab_rails['smtp_openssl_verify_mode'] = 'peer'
gitlab_rails['gitlab_email_from'] = 'gitlab@example.com'
gitlab_rails['gitlab_email_reply_to'] = 'noreply@example.com'
gitlab_rails['smtp_port'] = 465
gitlab_rails['smtp_enable_starttls_auto'] = false
#gitlab_rails['smtp_tls'] = true

#gitlab_rails['smtp_port'] = 587
#gitlab_rails['smtp_enable_starttls_auto'] = true
#gitlab_rails['smtp_tls'] = false

#gitlab_rails['smtp_port'] = 25
#gitlab_rails['smtp_enable_starttls_auto'] = false
#gitlab_rails['smtp_tls'] = false

保存退出。

不同的邮件服务需要做的配置大同小异，主流邮件解决方案的配置可以参考此页。需要注意的只有以下几个核心配置：

smtp_address：SMTP服务的地址
smtp_port：SMTP端口，有些邮箱服务可能会有单独指定的特殊端口
smtp_password：特别注意你使用的邮箱服务是否需要使用auth code（授权码）而非邮箱登录密码
gitlab_email_reply_to和gitlab_email_from：最好配置成你发邮件的邮箱服务相同的地址，否则某些邮箱服务的校验可能会无法通过。
二、刷新GitLab配置
1.如果是直接部署在物理机上的GitLab
可直接执行：

sudo gitlab-ctl reconfigure
2.如果是部署在Docker容器中的GitLab
先进入对应容器环境

sudo docker exec -it gitlab /bin/bash
随后执行刷新配置命令

gitlab-ctl reconfigure
三、测试邮件发送
在GitLab环境中启动rails console:

gitlab-rails console
使用命令测试一封邮件的发送（记得修改里面的收件人地址）：

Notify.test_email('youremail@email.com', 'Hello World', 'This is a test message').deliver_now
查看测试邮件是否收到。如果成功收到，说明SMTP服务配置成功。

四、问题排查
如果邮件发送遇到问题，可分以下几步进行排查：

1. 进入console:

gitlab-rails console
2. 检查SMTP是否已启用：

ActionMailer::Base.delivery_method
3. 检查SMTP详细配置：

ActionMailer::Base.smtp_settings