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

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:

KeyTypeDescriptionExample
EMAIL_FROMstringEndereço de e-mail de remetente. Obrigatório.[email protected]
EMAIL_FROM_NAMEstringNome do remetente (usa APP_TITLE como padrão se não definido).EMAIL_FROM_NAME=LibreChat

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.

KeyTypeDescriptionExample
MAILGUN_API_KEYstringSua chave de API do Mailgun (obrigatória para o Mailgun).MAILGUN_API_KEY=
MAILGUN_DOMAINstringSeu domínio Mailgun, ex.: mg.seudominio.com (obrigatório para Mailgun).MAILGUN_DOMAIN=
MAILGUN_HOSTstringHost 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

KeyTypeDescriptionExample
EMAIL_SERVICEstringServiço de e-mail (por exemplo, Gmail, Outlook).EMAIL_SERVICE=
EMAIL_USERNAMEstringNome de usuário para autenticação.EMAIL_USERNAME=
EMAIL_PASSWORDstringSenha 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:

KeyTypeDescriptionExample
EMAIL_HOSTstringHost do servidor de e-mail.EMAIL_HOST=
EMAIL_PORTnumberPorta do servidor de e-mail.EMAIL_PORT=25
EMAIL_ENCRYPTIONstringMétodo de criptografia (starttls, tls, etc.).EMAIL_ENCRYPTION=
EMAIL_ENCRYPTION_HOSTNAMEstringHostname para criptografia.EMAIL_ENCRYPTION_HOSTNAME=
EMAIL_ALLOW_SELFSIGNEDbooleanPermitir 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:

  1. Crie uma conta no Mailgun em mailgun.com
  2. Adicione e verifique seu domínio no painel do Mailgun
  3. Navegue até a seção API Keys e copie sua chave de API privada (Private API key)
  4. No arquivo .env, modifique as variáveis da seguinte forma:
KeyTypeDescriptionExample
MAILGUN_API_KEYstringSua chave de API privada do MailgunMAILGUN_API_KEY=your-mailgun-api-key
MAILGUN_DOMAINstringSeu domínio verificado do MailgunMAILGUN_DOMAIN=mg.yourdomain.com
EMAIL_FROMstringEndereço de e-mail do remetente[email protected]
EMAIL_FROM_NAMEstringNome do remetenteEMAIL_FROM_NAME=LibreChat
MAILGUN_HOSTstring(Opcional) Para a região da UEMAILGUN_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:

  1. Crie uma Conta Google e ative a verificação em duas etapas.
  2. Nas Google Account settings, clique na aba "Segurança" e abra a "Verificação em duas etapas".
  3. 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.
  4. Clique em "Generate" para criar uma senha e copie a senha gerada.
  5. No arquivo .env, modifique as variáveis da seguinte forma:
KeyTypeDescriptionExample
EMAIL_SERVICEstringgmailEMAIL_SERVICE=gmail
EMAIL_USERNAMEstringseu-emailEMAIL_USERNAME=your-email
EMAIL_PASSWORDstringsua-senha-de-emailEMAIL_PASSWORD=your-email-password
EMAIL_FROMstringendereço de e-mail para o campo from, por exemplo, [email protected][email protected]
EMAIL_FROM_NAMEstringMeu servidor LibreChatEMAIL_FROM_NAME=LibreChat

Configuração com servidor de e-mail personalizado

Para configurar um servidor de e-mail personalizado, siga estas etapas:

  1. 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.
  2. No arquivo .env, modifique as variáveis da seguinte forma, assumindo alguns valores de exemplo sensatos:
KeyTypeDescriptionExample
EMAIL_HOSTstringHostname para conexãoEMAIL_HOST=mail.example.com
EMAIL_PORTintegerPorta para conexãoEMAIL_PORT=25
EMAIL_ENCRYPTIONstringTipo de criptografiaEMAIL_ENCRYPTION=starttls
EMAIL_USERNAMEstringSeu nome de usuário de e-mail[email protected]
EMAIL_PASSWORDstringSua senha do aplicativoEMAIL_PASSWORD=password
EMAIL_FROMstringEndereço de e-mail para o campo remetente[email protected]
EMAIL_FROM_NAMEstringNome 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=true

Exemplo 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=true

Exemplo 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=true

Solução de problemas

Problemas com o Mailgun

  1. Falha na autenticação: Certifique-se de que sua chave de API do Mailgun esteja correta e possua permissões de envio
  2. Domínio não encontrado: Verifique se o seu domínio Mailgun está configurado corretamente na sua conta Mailgun
  3. 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
  4. Fallback para SMTP: Se apenas uma das variáveis MAILGUN_API_KEY ou MAILGUN_DOMAIN estiver definida, o sistema fará o fallback para a configuração de SMTP.

Problemas com SMTP

  1. Connection Refused: Verifique se o seu servidor permite conexões SMTP de saída na porta especificada
  2. Falha na Autenticação: Verifique se seu nome de usuário e senha estão corretos
  3. Senha de aplicativo do Gmail: Para o Gmail, você deve usar uma senha específica de aplicativo, não a sua senha comum.
  4. Certificados autoassinados: Se o seu servidor de e-mail utiliza certificados autoassinados, defina EMAIL_ALLOW_SELFSIGNED=true

Problemas Gerais

  1. Nenhum e-mail enviado: Verifique os logs do LibreChat para mensagens de erro
  2. Redefinição de senha não segura: Isso ocorre quando nem o Mailgun nem o SMTP estão configurados corretamente
  3. Problemas com o endereço "From": Certifique-se de que o endereço EMAIL_FROM seja válido e esteja autorizado a enviar e-mails pelo seu serviço de e-mail.

Como está este guia?