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

Thiết lập email

Hướng dẫn này giải thích cách cấu hình xác thực email/đặt lại mật khẩu bảo mật. Bạn có thể cấu hình để hoạt động với nhiều dịch vụ email khác nhau, bao gồm Gmail, Mailgun và các máy chủ thư tùy chỉnh.

Để có cái nhìn tổng quan nhanh, hãy tham khảo hướng dẫn sử dụng được cung cấp tại đây: Đặt lại mật khẩu

Thiết lập chung

LibreChat hỗ trợ nhiều nhà cung cấp email:

  • Mailgun API - Được khuyến nghị cho các máy chủ chặn cổng SMTP
  • Dịch vụ SMTP - Gửi email truyền thống thông qua Gmail, Outlook hoặc các máy chủ thư điện tử tùy chỉnh

Cấu hình chung

Các biến này được sử dụng bởi cả Mailgun và SMTP:

KeyTypeDescriptionExample
EMAIL_FROMstringĐịa chỉ email gửi. Bắt buộc.[email protected]
EMAIL_FROM_NAMEstringTên người gửi (mặc định là APP_TITLE nếu không được thiết lập).EMAIL_FROM_NAME=LibreChat

Mailgun đặc biệt hữu ích cho các triển khai trên máy chủ chặn cổng SMTP để ngăn chặn thư rác. Khi cả MAILGUN_API_KEYMAILGUN_DOMAIN đều được thiết lập, LibreChat sẽ sử dụng Mailgun thay vì SMTP.

KeyTypeDescriptionExample
MAILGUN_API_KEYstringKhóa API Mailgun của bạn (bắt buộc đối với Mailgun).MAILGUN_API_KEY=
MAILGUN_DOMAINstringTên miền Mailgun của bạn, ví dụ: mg.yourdomain.com (bắt buộc đối với Mailgun).MAILGUN_DOMAIN=
MAILGUN_HOSTstringMáy chủ API Mailgun tùy chỉnh (tùy chọn). Sử dụng https://api.eu.mailgun.net cho khu vực EU.MAILGUN_HOST=https://api.mailgun.net

Cấu hình SMTP

Cấu hình cơ bản

Nếu bạn muốn sử dụng một trong các dịch vụ được xác định trước, chỉ cần cấu hình các biến sau: Để biết thêm thông tin về các dịch vụ email được hỗ trợ: https://nodemailer.com/smtp/well-known-services

KeyTypeDescriptionExample
EMAIL_SERVICEstringDịch vụ email (ví dụ: Gmail, Outlook).EMAIL_SERVICE=
EMAIL_USERNAMEstringTên người dùng để xác thực.EMAIL_USERNAME=
EMAIL_PASSWORDstringMật khẩu để xác thực.EMAIL_PASSWORD=

Cấu hình nâng cao

Nếu bạn muốn sử dụng dịch vụ SMTP chung hoặc cần cấu hình nâng cao cho một trong các nhà cung cấp được xác định trước, hãy cấu hình thêm các biến sau:

KeyTypeDescriptionExample
EMAIL_HOSTstringMáy chủ mail host.EMAIL_HOST=
EMAIL_PORTnumberCổng máy chủ thư.EMAIL_PORT=25
EMAIL_ENCRYPTIONstringPhương thức mã hóa (starttls, tls, v.v.).EMAIL_ENCRYPTION=
EMAIL_ENCRYPTION_HOSTNAMEstringHostname để mã hóa.EMAIL_ENCRYPTION_HOSTNAME=
EMAIL_ALLOW_SELFSIGNEDbooleanCho phép chứng chỉ tự ký.EMAIL_ALLOW_SELFSIGNED=

Cảnh báo

Việc không cấu hình đúng Mailgun hoặc SMTP sẽ khiến LibreChat sử dụng tính năng đặt lại mật khẩu không bảo mật! Điều này cho phép bất kỳ ai cũng có thể đặt lại mật khẩu trên máy chủ của bạn ngay lập tức mà không cần gửi email!

Thiết lập với Mailgun

Để thiết lập Mailgun, hãy làm theo các bước sau:

  1. Đăng ký tài khoản Mailgun tại mailgun.com
  2. Thêm và xác minh miền của bạn trong bảng điều khiển Mailgun
  3. Điều hướng đến phần API Keys và sao chép Private API key của bạn
  4. Trong tệp .env, hãy sửa đổi các biến như sau:
KeyTypeDescriptionExample
MAILGUN_API_KEYstringKhóa API riêng tư Mailgun của bạnMAILGUN_API_KEY=your-mailgun-api-key
MAILGUN_DOMAINstringTên miền Mailgun đã xác minh của bạnMAILGUN_DOMAIN=mg.yourdomain.com
EMAIL_FROMstringĐịa chỉ email người gửi[email protected]
EMAIL_FROM_NAMEstringTên người gửiEMAIL_FROM_NAME=LibreChat
MAILGUN_HOSTstring(Tùy chọn) Dành cho khu vực EUMAILGUN_HOST=https://api.eu.mailgun.net

Lưu ý

Nếu tài khoản Mailgun của bạn thuộc khu vực EU, hãy đảm bảo thiết lập MAILGUN_HOST=https://api.eu.mailgun.net

Thiết lập với Gmail

Để thiết lập Gmail, hãy làm theo các bước sau:

  1. Tạo một Tài khoản Google và bật xác minh 2 bước.
  2. Trong Google Account settings, hãy nhấp vào tab "Security" và mở "2-step verification."
  3. Cuộn xuống và mở "App passwords." Chọn "Mail" cho ứng dụng và chọn "Other" cho thiết bị, sau đó đặt một tên bất kỳ cho nó.
  4. Nhấp vào "Generate" để tạo mật khẩu và sao chép mật khẩu đã tạo.
  5. Trong tệp .env, hãy sửa đổi các biến như sau:
KeyTypeDescriptionExample
EMAIL_SERVICEstringgmailEMAIL_SERVICE=gmail
EMAIL_USERNAMEstringemail-của-bạnEMAIL_USERNAME=your-email
EMAIL_PASSWORDstringmật-khẩu-email-của-bạnEMAIL_PASSWORD=your-email-password
EMAIL_FROMstringđịa chỉ email cho trường from, ví dụ: [email protected][email protected]
EMAIL_FROM_NAMEstringMáy chủ LibreChat của tôiEMAIL_FROM_NAME=LibreChat

Thiết lập với máy chủ mail tùy chỉnh

Để thiết lập máy chủ thư tùy chỉnh, hãy làm theo các bước sau:

  1. Thu thập dữ liệu đăng nhập SMTP từ nhà cung cấp của bạn. Các bước thực hiện sẽ khác nhau tùy theo từng nhà cung cấp, nhưng họ thường sẽ liệt kê các giá trị cho tất cả các biến.
  2. Trong tệp .env, hãy sửa đổi các biến như sau, giả định một số giá trị ví dụ hợp lý:
KeyTypeDescriptionExample
EMAIL_HOSTstringTên máy chủ để kết nốiEMAIL_HOST=mail.example.com
EMAIL_PORTintegerCổng để kết nốiEMAIL_PORT=25
EMAIL_ENCRYPTIONstringLoại mã hóaEMAIL_ENCRYPTION=starttls
EMAIL_USERNAMEstringTên người dùng email của bạn[email protected]
EMAIL_PASSWORDstringMật khẩu ứng dụng của bạnEMAIL_PASSWORD=password
EMAIL_FROMstringĐịa chỉ email cho trường người gửi[email protected]
EMAIL_FROM_NAMEstringTên sẽ xuất hiện trong trường "từ"EMAIL_FROM_NAME=LibreChat

Các ví dụ cấu hình hoàn chỉnh

Ví dụ 1: Cấu hình 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

Ví dụ 2: Cấu hình SMTP Gmail

# ===================================
# 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

Ví dụ 3: Cấu hình máy chủ SMTP tùy chỉnh

# ===================================
# 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

Khắc phục sự cố

Các vấn đề với Mailgun

  1. Xác thực thất bại: Đảm bảo rằng khóa API Mailgun của bạn là chính xác và có quyền gửi thư
  2. Domain Not Found: Xác minh rằng tên miền Mailgun của bạn đã được cấu hình chính xác trong tài khoản Mailgun của bạn
  3. Các vấn đề về khu vực EU: Nếu tài khoản Mailgun của bạn nằm trong khu vực EU, hãy đảm bảo đặt MAILGUN_HOST=https://api.eu.mailgun.net
  4. Fallback to SMTP: Nếu chỉ một trong hai biến MAILGUN_API_KEY hoặc MAILGUN_DOMAIN được thiết lập, hệ thống sẽ chuyển sang sử dụng cấu hình SMTP.

Các vấn đề về SMTP

  1. Connection Refused: Kiểm tra xem máy chủ của bạn có cho phép kết nối SMTP đi trên cổng đã chỉ định hay không
  2. Authentication Failed: Xác minh tên người dùng và mật khẩu của bạn đã chính xác
  3. Gmail App Password: Đối với Gmail, bạn phải sử dụng mật khẩu ứng dụng (app-specific password), không phải mật khẩu thông thường của bạn
  4. Chứng chỉ tự ký (Self-signed Certificates): Nếu máy chủ thư điện tử của bạn sử dụng chứng chỉ tự ký, hãy đặt EMAIL_ALLOW_SELFSIGNED=true

Các vấn đề chung

  1. Không gửi được email: Kiểm tra nhật ký (logs) của LibreChat để xem các thông báo lỗi
  2. Đặt lại mật khẩu không bảo mật: Điều này xảy ra khi cả Mailgun và SMTP đều không được cấu hình đúng cách
  3. Các vấn đề về địa chỉ gửi (From Address): Đảm bảo địa chỉ EMAIL_FROM hợp lệ và được ủy quyền để gửi từ dịch vụ thư điện tử của bạn.

Hướng dẫn này thế nào?