Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

电子邮件设置

本指南介绍了如何配置安全电子邮件验证/密码重置。您可以将其配置为与各种电子邮件服务配合使用,包括 Gmail、Mailgun 和自定义邮件服务器。

如需快速了解,请参阅此处提供的用户指南:密码重置

常规设置

LibreChat 支持多种电子邮件提供商:

  • Mailgun API - 推荐用于屏蔽了 SMTP 端口的服务器
  • SMTP 服务 - 通过 Gmail、Outlook 或自定义邮件服务器进行传统邮件发送

常见配置

这些变量同时被 Mailgun 和 SMTP 使用:

KeyTypeDescriptionExample
EMAIL_FROMstring发件人电子邮件地址。必填。[email protected]
EMAIL_FROM_NAMEstring发件人名称(若未设置,则默认为 APP_TITLE)。EMAIL_FROM_NAME=LibreChat

对于在阻止 SMTP 端口以防止垃圾邮件的服务器上进行部署,Mailgun 特别有用。当同时设置了 MAILGUN_API_KEYMAILGUN_DOMAIN 时,LibreChat 将使用 Mailgun 而不是 SMTP。

KeyTypeDescriptionExample
MAILGUN_API_KEYstring您的 Mailgun API 密钥(Mailgun 所必需)。MAILGUN_API_KEY=
MAILGUN_DOMAINstring您的 Mailgun 域名,例如 mg.yourdomain.com(Mailgun 必需)。MAILGUN_DOMAIN=
MAILGUN_HOSTstringCustom Mailgun API host (optional). Use https://api.eu.mailgun.net for EU region.MAILGUN_HOST=https://api.mailgun.net

SMTP 配置

基本配置

如果您想使用预定义的服务之一,只需配置这些变量: 有关支持的电子邮件服务的更多信息:https://nodemailer.com/smtp/well-known-services

KeyTypeDescriptionExample
EMAIL_SERVICEstring电子邮件服务(例如 Gmail、Outlook)。EMAIL_SERVICE=
EMAIL_USERNAMEstring用于身份验证的用户名。EMAIL_USERNAME=
EMAIL_PASSWORDstring用于身份验证的密码。EMAIL_PASSWORD=

高级配置

如果您想使用通用的 SMTP 服务,或者需要为预定义的提供商进行高级配置,请同时配置以下变量:

KeyTypeDescriptionExample
EMAIL_HOSTstring邮件服务器主机EMAIL_HOST=
EMAIL_PORTnumber邮件服务器端口。EMAIL_PORT=25
EMAIL_ENCRYPTIONstring加密方法 (starttls, tls 等)。EMAIL_ENCRYPTION=
EMAIL_ENCRYPTION_HOSTNAMEstring用于加密的主机名。EMAIL_ENCRYPTION_HOSTNAME=
EMAIL_ALLOW_SELFSIGNEDboolean允许自签名证书。EMAIL_ALLOW_SELFSIGNED=

警告

如果未能正确配置 Mailgun 或 SMTP,LibreChat 将会使用不安全的密码重置方式!这将允许任何人立即重置服务器上的任何密码,且无需发送任何邮件!

使用 Mailgun 进行设置

要设置 Mailgun,请按照以下步骤操作:

  1. mailgun.com 注册一个 Mailgun 账户
  2. 在 Mailgun 控制面板中添加并验证您的域名
  3. 导航至 API Keys 部分并复制您的 Private API key
  4. .env 文件中,按如下方式修改变量:
KeyTypeDescriptionExample
MAILGUN_API_KEYstring您的 Mailgun 私有 API 密钥MAILGUN_API_KEY=your-mailgun-api-key
MAILGUN_DOMAINstring您已验证的 Mailgun 域名MAILGUN_DOMAIN=mg.yourdomain.com
EMAIL_FROMstring发件人电子邮件地址[email protected]
EMAIL_FROM_NAMEstring发送者名称EMAIL_FROM_NAME=LibreChat
MAILGUN_HOSTstring(可选)针对欧盟地区MAILGUN_HOST=https://api.eu.mailgun.net

注意

如果您的 Mailgun 账户位于欧盟区域,请确保设置 MAILGUN_HOST=https://api.eu.mailgun.net

使用 Gmail 进行设置

要设置 Gmail,请按照以下步骤操作:

  1. 创建一个 Google 账号并启用两步验证。
  2. Google Account settings 中,点击“安全性”选项卡并打开“两步验证”。
  3. 向下滚动并打开“App passwords”。为应用选择“Mail”,为设备选择“Other”,然后为其指定一个任意名称。
  4. 点击“Generate”生成密码,并复制生成的密码。
  5. .env 文件中,按如下方式修改变量:
KeyTypeDescriptionExample
EMAIL_SERVICEstringGmailEMAIL_SERVICE=gmail
EMAIL_USERNAMEstring您的电子邮箱EMAIL_USERNAME=your-email
EMAIL_PASSWORDstring您的电子邮箱密码EMAIL_PASSWORD=your-email-password
EMAIL_FROMstring发件人字段的电子邮件地址,例如 [email protected][email protected]
EMAIL_FROM_NAMEstring我的 LibreChat 服务器EMAIL_FROM_NAME=LibreChat

使用自定义邮件服务器进行设置

要设置自定义邮件服务器,请按照以下步骤操作:

  1. 从您的提供商处获取您的 SMTP 登录数据。每个提供商的步骤各不相同,但他们通常会列出所有变量的值。
  2. .env 文件中,按如下方式修改变量(假设了一些合理的示例值):
KeyTypeDescriptionExample
EMAIL_HOSTstring连接的主机名EMAIL_HOST=mail.example.com
EMAIL_PORTinteger连接端口EMAIL_PORT=25
EMAIL_ENCRYPTIONstring加密类型EMAIL_ENCRYPTION=starttls
EMAIL_USERNAMEstring您的电子邮件用户名[email protected]
EMAIL_PASSWORDstring您的应用密码EMAIL_PASSWORD=password
EMAIL_FROMstring“发件人”字段的电子邮件地址[email protected]
EMAIL_FROM_NAMEstring将显示在“发件人”字段中的名称EMAIL_FROM_NAME=LibreChat

完整配置示例

示例 1:Mailgun 配置

# ===================================
# Email Configuration - Mailgun
# ===================================
# Mailgun is recommended for servers that block SMTP ports

# Required Mailgun settings
MAILGUN_API_KEY=your-mailgun-api-key
MAILGUN_DOMAIN=mg.yourdomain.com

# Optional: For EU region
# MAILGUN_HOST=https://api.eu.mailgun.net

# Common email settings
EMAIL_FROM=[email protected]
EMAIL_FROM_NAME=LibreChat

# Enable password reset functionality
ALLOW_PASSWORD_RESET=true

示例 2:Gmail SMTP 配置

# ===================================
# Email Configuration - Gmail SMTP
# ===================================
# Traditional SMTP configuration

# Gmail service configuration
EMAIL_SERVICE=gmail
EMAIL_USERNAME=[email protected]
EMAIL_PASSWORD=your-app-password

# Common email settings
EMAIL_FROM=[email protected]
EMAIL_FROM_NAME=LibreChat

# Enable password reset functionality
ALLOW_PASSWORD_RESET=true

示例 3:自定义 SMTP 服务器配置

# ===================================
# Email Configuration - Custom SMTP
# ===================================
# For custom mail servers

# SMTP server details
EMAIL_HOST=smtp.example.com
EMAIL_PORT=587
EMAIL_ENCRYPTION=starttls
EMAIL_USERNAME=[email protected]
EMAIL_PASSWORD=your-password

# Optional settings
# EMAIL_ENCRYPTION_HOSTNAME=
# EMAIL_ALLOW_SELFSIGNED=false

# Common email settings
EMAIL_FROM=[email protected]
EMAIL_FROM_NAME=LibreChat

# Enable password reset functionality
ALLOW_PASSWORD_RESET=true

故障排除

Mailgun 问题

  1. 身份验证失败:请确保您的 Mailgun API 密钥正确且拥有发送权限
  2. 找不到域名:请核实您的 Mailgun 域名是否已在您的 Mailgun 账户中正确配置
  3. EU 地区问题:如果您的 Mailgun 账户位于 EU 地区,请确保设置 MAILGUN_HOST=https://api.eu.mailgun.net
  4. 回退至 SMTP:如果仅设置了 MAILGUN_API_KEYMAILGUN_DOMAIN 中的一项,系统将回退至 SMTP 配置。

SMTP 问题

  1. Connection Refused: 请检查您的服务器是否允许在指定端口进行出站 SMTP 连接
  2. 身份验证失败:请核实您的用户名和密码是否正确
  3. Gmail 应用专用密码 (App Password):对于 Gmail,您必须使用应用专用密码,而不是您的常规密码
  4. 自签名证书:如果您的邮件服务器使用自签名证书,请设置 EMAIL_ALLOW_SELFSIGNED=true

常见问题

  1. 未发送电子邮件:检查 LibreChat 日志以获取错误消息
  2. 未受保护的密码重置:当 Mailgun 或 SMTP 未正确配置时,会出现此情况
  3. From 地址问题:确保 EMAIL_FROM 地址有效,并已获得从您的邮件服务发送邮件的授权。

这篇指南怎么样?