Configuração de e-mail
Este guia explica como configurar a verificação de e-mail/redefinição de senha segura. Você pode configurá-lo para funcionar com vários serviços de e-mail, incluindo Gmail, Mailgun e servidores de e-mail personalizados.
Para uma visão geral rápida, consulte o guia do usuário fornecido aqui: Password Reset
Configuração geral
O LibreChat oferece suporte a vários provedores de e-mail:
- Mailgun API - Recomendado para servidores que bloqueiam portas SMTP
- Serviços SMTP - Envio de e-mail tradicional via Gmail, Outlook ou servidores de e-mail personalizados
Configuração Comum
Estas variáveis são usadas tanto pelo Mailgun quanto pelo SMTP:
| Key | Type | Description | Example |
|---|---|---|---|
| EMAIL_FROM | string | Endereço de e-mail de remetente. Obrigatório. | [email protected] |
| EMAIL_FROM_NAME | string | Nome do remetente (usa APP_TITLE como padrão se não definido). | EMAIL_FROM_NAME=LibreChat |
Configuração do Mailgun (Recomendado)
O Mailgun é particularmente útil para implantações em servidores que bloqueiam portas SMTP para evitar spam. Quando MAILGUN_API_KEY e MAILGUN_DOMAIN estão definidos, o LibreChat usará o Mailgun em vez de SMTP.
| Key | Type | Description | Example |
|---|---|---|---|
| MAILGUN_API_KEY | string | Sua chave de API do Mailgun (obrigatória para o Mailgun). | MAILGUN_API_KEY= |
| MAILGUN_DOMAIN | string | Seu domínio Mailgun, ex.: mg.seudominio.com (obrigatório para Mailgun). | MAILGUN_DOMAIN= |
| MAILGUN_HOST | string | Host da API do Mailgun personalizado (opcional). Use https://api.eu.mailgun.net para a região da UE. | MAILGUN_HOST=https://api.mailgun.net |
Configuração de SMTP
Configuração Básica
Se você quiser usar um dos serviços predefinidos, configure apenas estas variáveis: Para mais informações sobre serviços de e-mail suportados: https://nodemailer.com/smtp/well-known-services
| Key | Type | Description | Example |
|---|---|---|---|
| EMAIL_SERVICE | string | Serviço de e-mail (por exemplo, Gmail, Outlook). | EMAIL_SERVICE= |
| EMAIL_USERNAME | string | Nome de usuário para autenticação. | EMAIL_USERNAME= |
| EMAIL_PASSWORD | string | Senha para autenticação. | EMAIL_PASSWORD= |
Configuração Avançada
Se você deseja usar um serviço SMTP genérico ou precisa de uma configuração avançada para um dos provedores predefinidos, configure estas variáveis também:
| Key | Type | Description | Example |
|---|---|---|---|
| EMAIL_HOST | string | Host do servidor de e-mail. | EMAIL_HOST= |
| EMAIL_PORT | number | Porta do servidor de e-mail. | EMAIL_PORT=25 |
| EMAIL_ENCRYPTION | string | Método de criptografia (starttls, tls, etc.). | EMAIL_ENCRYPTION= |
| EMAIL_ENCRYPTION_HOSTNAME | string | Hostname para criptografia. | EMAIL_ENCRYPTION_HOSTNAME= |
| EMAIL_ALLOW_SELFSIGNED | boolean | Permitir certificados autoassinados. | EMAIL_ALLOW_SELFSIGNED= |
Aviso
A falha em configurar corretamente o Mailgun ou o SMTP fará com que o LibreChat utilize a redefinição de senha não segura! Isso permite que qualquer pessoa redefina qualquer senha em seu servidor imediatamente, sem que nenhum e-mail seja enviado!
Configuração com Mailgun
Para configurar o Mailgun, siga estas etapas:
- Crie uma conta no Mailgun em mailgun.com
- Adicione e verifique seu domínio no painel do Mailgun
- Navegue até a seção API Keys e copie sua chave de API privada (Private API key)
- No arquivo
.env, modifique as variáveis da seguinte forma:
| Key | Type | Description | Example |
|---|---|---|---|
| MAILGUN_API_KEY | string | Sua chave de API privada do Mailgun | MAILGUN_API_KEY=your-mailgun-api-key |
| MAILGUN_DOMAIN | string | Seu domínio verificado do Mailgun | MAILGUN_DOMAIN=mg.yourdomain.com |
| EMAIL_FROM | string | Endereço de e-mail do remetente | [email protected] |
| EMAIL_FROM_NAME | string | Nome do remetente | EMAIL_FROM_NAME=LibreChat |
| MAILGUN_HOST | string | (Opcional) Para a região da UE | MAILGUN_HOST=https://api.eu.mailgun.net |
Nota
Se a sua conta Mailgun estiver na região da UE, certifique-se de definir MAILGUN_HOST=https://api.eu.mailgun.net
Configuração com Gmail
Para configurar o Gmail, siga estas etapas:
- Crie uma Conta Google e ative a verificação em duas etapas.
- Nas Google Account settings, clique na aba "Segurança" e abra a "Verificação em duas etapas".
- Role para baixo e abra "App passwords." Escolha "Mail" para o aplicativo e selecione "Other" para o dispositivo, então dê a ele um nome qualquer.
- Clique em "Generate" para criar uma senha e copie a senha gerada.
- No arquivo
.env, modifique as variáveis da seguinte forma:
| Key | Type | Description | Example |
|---|---|---|---|
| EMAIL_SERVICE | string | gmail | EMAIL_SERVICE=gmail |
| EMAIL_USERNAME | string | seu-email | EMAIL_USERNAME=your-email |
| EMAIL_PASSWORD | string | sua-senha-de-email | EMAIL_PASSWORD=your-email-password |
| EMAIL_FROM | string | endereço de e-mail para o campo from, por exemplo, [email protected] | [email protected] |
| EMAIL_FROM_NAME | string | Meu servidor LibreChat | EMAIL_FROM_NAME=LibreChat |
Configuração com servidor de e-mail personalizado
Para configurar um servidor de e-mail personalizado, siga estas etapas:
- Reúna seus dados de login SMTP do seu provedor. As etapas são diferentes para cada um, mas eles geralmente listarão os valores para todas as variáveis.
- No arquivo
.env, modifique as variáveis da seguinte forma, assumindo alguns valores de exemplo sensatos:
| Key | Type | Description | Example |
|---|---|---|---|
| EMAIL_HOST | string | Hostname para conexão | EMAIL_HOST=mail.example.com |
| EMAIL_PORT | integer | Porta para conexão | EMAIL_PORT=25 |
| EMAIL_ENCRYPTION | string | Tipo de criptografia | EMAIL_ENCRYPTION=starttls |
| EMAIL_USERNAME | string | Seu nome de usuário de e-mail | [email protected] |
| EMAIL_PASSWORD | string | Sua senha do aplicativo | EMAIL_PASSWORD=password |
| EMAIL_FROM | string | Endereço de e-mail para o campo remetente | [email protected] |
| EMAIL_FROM_NAME | string | Nome que aparecerá no campo "de" | EMAIL_FROM_NAME=LibreChat |
Exemplos Completos de Configuração
Exemplo 1: Configuração do 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=trueExemplo 2: Configuração de SMTP do 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=trueExemplo 3: Configuração de Servidor SMTP Personalizado
# ===================================
# 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=trueSolução de problemas
Problemas com o Mailgun
- Falha na autenticação: Certifique-se de que sua chave de API do Mailgun esteja correta e possua permissões de envio
- Domínio não encontrado: Verifique se o seu domínio Mailgun está configurado corretamente na sua conta Mailgun
- Problemas com a região da UE: Se sua conta Mailgun estiver na região da UE, certifique-se de definir
MAILGUN_HOST=https://api.eu.mailgun.net - Fallback para SMTP: Se apenas uma das variáveis
MAILGUN_API_KEYouMAILGUN_DOMAINestiver definida, o sistema fará o fallback para a configuração de SMTP.
Problemas com SMTP
- Connection Refused: Verifique se o seu servidor permite conexões SMTP de saída na porta especificada
- Falha na Autenticação: Verifique se seu nome de usuário e senha estão corretos
- Senha de aplicativo do Gmail: Para o Gmail, você deve usar uma senha específica de aplicativo, não a sua senha comum.
- Certificados autoassinados: Se o seu servidor de e-mail utiliza certificados autoassinados, defina
EMAIL_ALLOW_SELFSIGNED=true
Problemas Gerais
- Nenhum e-mail enviado: Verifique os logs do LibreChat para mensagens de erro
- Redefinição de senha não segura: Isso ocorre quando nem o Mailgun nem o SMTP estão configurados corretamente
- Problemas com o endereço "From": Certifique-se de que o endereço
EMAIL_FROMseja válido e esteja autorizado a enviar e-mails pelo seu serviço de e-mail.
Como está este guia?
Sistema de Autenticação
Este guia explica como usar o sistema de autenticação de usuário do LibreChat, que oferece logins seguros e fáceis por e-mail e redes sociais. Você aprenderá a configurar o cadastro, login, redefinição de senha e muito mais.
LDAP/AD
Aprenda a configurar o LibreChat para usar LDAP para autenticação de usuários.