📧 feat: Allow usage of custom SMTP server (#1219)

Co-authored-by: David Reis <post@d-reis.com>
2025-12-17 00:40:14 +01:00 · 2023-11-29 00:00:07 +01:00 · 2023-11-29 00:00:07 +01:00 · ae03267d9b
commit ae03267d9b
parent 3838ff4617
5 changed files with 155 additions and 85 deletions
--- a/.env.example
+++ b/.env.example
@ -1,10 +1,10 @@
 ##########################
-# Server configuration: 
+# Server configuration:
 ##########################

 APP_TITLE=LibreChat

-# Uncomment to add a custom footer. 
+# Uncomment to add a custom footer.
 # Uncomment and make empty "" to remove the footer.
 # CUSTOM_FOOTER="My custom footer"

@ -15,11 +15,11 @@ APP_TITLE=LibreChat

 # ENDPOINTS=openAI,azureOpenAI,bingAI,chatGPTBrowser,google,gptPlugins,anthropic

-# The server will listen to localhost:3080 by default. You can change the target IP as you want. 
-# If you want to make this server available externally, for example to share the server with others 
-# or expose this from a Docker container, set host to 0.0.0.0 or your external IP interface. 
-# Tips: Setting host to 0.0.0.0 means listening on all interfaces. It's not a real IP.  
-# Use localhost:port rather than 0.0.0.0:port to access the server. 
+# The server will listen to localhost:3080 by default. You can change the target IP as you want.
+# If you want to make this server available externally, for example to share the server with others
+# or expose this from a Docker container, set host to 0.0.0.0 or your external IP interface.
+# Tips: Setting host to 0.0.0.0 means listening on all interfaces. It's not a real IP.
+# Use localhost:port rather than 0.0.0.0:port to access the server.
 # Set Node env to development if running in dev mode.
 HOST=localhost
 PORT=3080
@ -83,27 +83,27 @@ MESSAGE_USER_WINDOW=1 # in minutes, determines the window of time for MESSAGE_US
 # UID=1000
 # GID=1000

-# Change this to proxy any API request. 
-# It's useful if your machine has difficulty calling the original API server. 
+# Change this to proxy any API request.
+# It's useful if your machine has difficulty calling the original API server.
 # PROXY=

-# Change this to your MongoDB URI if different. I recommend appending LibreChat. 
+# Change this to your MongoDB URI if different. I recommend appending LibreChat.
 MONGO_URI=mongodb://127.0.0.1:27018/LibreChat

 ##########################
-# OpenAI Endpoint: 
+# OpenAI Endpoint:
 ##########################

-# Access key from OpenAI platform. 
+# Access key from OpenAI platform.
 # Leave it blank to disable this feature.
 # Set to "user_provided" to allow the user to provide their API key from the UI.
 OPENAI_API_KEY=user_provided

 DEBUG_OPENAI=false # Set to true to enable debug mode for the OpenAI endpoint

-# Identify the available models, separated by commas *without spaces*. 
-# The first will be default. 
-# Leave it blank to use internal settings. 
+# Identify the available models, separated by commas *without spaces*.
+# The first will be default.
+# Leave it blank to use internal settings.
 # OPENAI_MODELS=gpt-3.5-turbo-1106,gpt-4-1106-preview,gpt-3.5-turbo,gpt-3.5-turbo-16k,gpt-3.5-turbo-0301,text-davinci-003,gpt-4,gpt-4-0314,gpt-4-0613

 # Titling is enabled by default when initiating a conversation.
@ -129,7 +129,7 @@ DEBUG_OPENAI=false # Set to true to enable debug mode for the OpenAI endpoint
 # Must be compatible with the OpenAI Endpoint.
 # OPENAI_SUMMARY_MODEL=gpt-3.5-turbo

-# Reverse proxy settings for OpenAI: 
+# Reverse proxy settings for OpenAI:
 # https://github.com/waylaidwanderer/node-chatgpt-api#using-a-reverse-proxy
 # The URL must match the "url/v1," pattern, the "openai" suffix is also allowed.
 # Examples:
@ -145,12 +145,15 @@ DEBUG_OPENAI=false # Set to true to enable debug mode for the OpenAI endpoint
 # This may be the case for LocalAI with some models. To do so, uncomment the following:
 # OPENAI_FORCE_PROMPT=true

-# (Advanced) For customization of the DALL-E-3 System prompt, 
+# (Advanced) For customization of the DALL-E-3 System prompt,
 # uncomment the following, and provide your own prompt:
 # See official prompt for reference:
 # https://github.com/spdustin/ChatGPT-AutoExpert/blob/main/_system-prompts/dall-e.md
 # DALLE3_SYSTEM_PROMPT="Your System Prompt here"

+# OpenAI API key for DALL-E / DALL-E-3. Set to user_provided to have the user provide their own key when installing the pluigin.
+# DALLE_API_KEY=user_provided
+
 # (Advanced) DALL-E Proxy settings
 # This is separate from its OpenAI counterpart for customization purposes

@ -166,7 +169,7 @@ DEBUG_OPENAI=false # Set to true to enable debug mode for the OpenAI endpoint
 # Note: if you have PROXY set, it will be used for DALLE calls also, which is universal for the app

 ##########################
-# OpenRouter (overrides OpenAI and Plugins Endpoints): 
+# OpenRouter (overrides OpenAI and Plugins Endpoints):
 ##########################

 # OpenRouter is a legitimate proxy service to a multitude of LLMs, both closed and open source, including:
@ -179,11 +182,11 @@ DEBUG_OPENAI=false # Set to true to enable debug mode for the OpenAI endpoint
 # OPENROUTER_API_KEY=

 ##########################
-# AZURE Endpoint:   
+# AZURE Endpoint:
 ##########################

 # To use Azure with this project, set the following variables. These will be used to build the API URL.
-# Chat completion: 
+# Chat completion:
 # `https://{AZURE_OPENAI_API_INSTANCE_NAME}.openai.azure.com/openai/deployments/{AZURE_OPENAI_API_DEPLOYMENT_NAME}/chat/completions?api-version={AZURE_OPENAI_API_VERSION}`;
 # You should also consider changing the `OPENAI_MODELS` variable above to the models available in your instance/deployment.
 # Note: I've noticed that the Azure API is much faster than the OpenAI API, so the streaming looks almost instantaneous.
@ -202,7 +205,7 @@ DEBUG_OPENAI=false # Set to true to enable debug mode for the OpenAI endpoint
 # However, you can use non-model deployment names and setting the AZURE_OPENAI_DEFAULT_MODEL to ensure it works as expected.

 # Identify the available models, separated by commas *without spaces*.
-# The first will be default. Leave it blank or as is to use internal settings. 
+# The first will be default. Leave it blank or as is to use internal settings.
 # NOTE: as deployment names can't have periods, they will be removed when the endpoint is generated.
 AZURE_OPENAI_MODELS=gpt-3.5-turbo,gpt-4

@ -220,18 +223,18 @@ AZURE_USE_MODEL_AS_DEPLOYMENT_NAME=TRUE
 # PLUGINS_USE_AZURE="true"

 ##########################
-# ChatGPT Endpoint: 
+# ChatGPT Endpoint:
 ##########################

-# ChatGPT Browser Client (free but use at your own risk) 
-# Access token from https://chat.openai.com/api/auth/session 
+# ChatGPT Browser Client (free but use at your own risk)
+# Access token from https://chat.openai.com/api/auth/session
 # Exposes your access token to `CHATGPT_REVERSE_PROXY`
 # Set to "user_provided" to allow the user to provide its token from the UI.
-# Leave it blank to disable this endpoint 
+# Leave it blank to disable this endpoint
 CHATGPT_TOKEN=user_provided

-# Identify the available models, separated by commas. The first will be default. 
-# Leave it blank to use internal settings. 
+# Identify the available models, separated by commas. The first will be default.
+# Leave it blank to use internal settings.
 CHATGPT_MODELS=text-davinci-002-render-sha,gpt-4
 # NOTE: you can add gpt-4-plugins, gpt-4-code-interpreter, and gpt-4-browsing to the list above and use the models for these features;
 # however, the view/display portion of these features are not supported, but you can use the underlying models, which have higher token context
@ -243,30 +246,30 @@ CHATGPT_MODELS=text-davinci-002-render-sha,gpt-4
 # CHATGPT_REVERSE_PROXY=<YOUR REVERSE PROXY>

 ##########################
-# BingAI Endpoint:   
+# BingAI Endpoint:
 ##########################

 # Also used for Sydney and jailbreak
 # To get your Access token for Bing, login to https://www.bing.com
-# Use dev tools or an extension while logged into the site to copy the content of the _U cookie. 
-# If this fails, follow these instructions https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302 to provide the full cookie strings 
+# Use dev tools or an extension while logged into the site to copy the content of the _U cookie.
+# If this fails, follow these instructions https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302 to provide the full cookie strings
 # or check out our discord https://discord.com/channels/1086345563026489514/1143941308684177429
 # Set to "user_provided" to allow the user to provide its token from the UI.
-# Leave it blank to disable this endpoint. 
+# Leave it blank to disable this endpoint.
 BINGAI_TOKEN=user_provided

-# BingAI Host: 
-# Necessary for some people in different countries, e.g. China (https://cn.bing.com) 
-# Leave it blank to use default server. 
-# BINGAI_HOST=https://cn.bing.com 
+# BingAI Host:
+# Necessary for some people in different countries, e.g. China (https://cn.bing.com)
+# Leave it blank to use default server.
+# BINGAI_HOST=https://cn.bing.com

 #############################
 # Plugins:
 #############################

-# Identify the available models, separated by commas *without spaces*. 
-# The first will be default. 
-# Leave it blank to use internal settings. 
+# Identify the available models, separated by commas *without spaces*.
+# The first will be default.
+# Leave it blank to use internal settings.
 # PLUGIN_MODELS=gpt-3.5-turbo,gpt-3.5-turbo-16k,gpt-3.5-turbo-0301,gpt-4,gpt-4-0314,gpt-4-0613

 DEBUG_PLUGINS=true # Set to false or comment out to disable debug mode for plugins
@ -279,8 +282,8 @@ DEBUG_PLUGINS=true # Set to false or comment out to disable debug mode for plugi
 CREDS_KEY=f34be427ebb29de8d88c107a71546019685ed8b241d8f2ed00c3df97ad2566f0
 CREDS_IV=e2341419ec3dd3d19b13a1a87fafcbfb

-# AI-Assisted Google Search  
-# This bot supports searching google for answers to your questions with assistance from GPT! 
+# AI-Assisted Google Search
+# This bot supports searching google for answers to your questions with assistance from GPT!
 # See detailed instructions here: https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/google_search.md
 GOOGLE_API_KEY=
 GOOGLE_CSE_ID=
@ -304,7 +307,7 @@ AZURE_COGNITIVE_SEARCH_SEARCH_OPTION_TOP=
 AZURE_COGNITIVE_SEARCH_SEARCH_OPTION_SELECT=

 ##########################
-# PaLM (Google) Endpoint: 
+# PaLM (Google) Endpoint:
 ##########################

 # Follow the instruction here to setup:
@ -313,10 +316,10 @@ AZURE_COGNITIVE_SEARCH_SEARCH_OPTION_SELECT=
 PALM_KEY=user_provided

 # In case you need a reverse proxy for this endpoint:
-# GOOGLE_REVERSE_PROXY= 
+# GOOGLE_REVERSE_PROXY=

 ##########################
-# Anthropic Endpoint: 
+# Anthropic Endpoint:
 ##########################
 # Access key from https://console.anthropic.com/
 # Leave it blank to disable this feature.
@ -337,28 +340,28 @@ ANTHROPIC_MODELS=claude-1,claude-instant-1,claude-2
 PROXY=

 ##########################
-# Search: 
+# Search:
 ##########################

-# ENABLING SEARCH MESSAGES/CONVOS 
-# Requires the installation of the free self-hosted Meilisearch or a paid Remote Plan (Remote not tested) 
-# The easiest setup for this is through docker-compose, which takes care of it for you. 
+# ENABLING SEARCH MESSAGES/CONVOS
+# Requires the installation of the free self-hosted Meilisearch or a paid Remote Plan (Remote not tested)
+# The easiest setup for this is through docker-compose, which takes care of it for you.
 SEARCH=true

 # HIGHLY RECOMMENDED: Disable anonymized telemetry analytics for MeiliSearch for absolute privacy.
 MEILI_NO_ANALYTICS=true

-# REQUIRED FOR SEARCH: MeiliSearch Host, mainly for the API server to connect to the search server. 
-# Replace '0.0.0.0' with 'meilisearch' if serving MeiliSearch with docker-compose. 
+# REQUIRED FOR SEARCH: MeiliSearch Host, mainly for the API server to connect to the search server.
+# Replace '0.0.0.0' with 'meilisearch' if serving MeiliSearch with docker-compose.
 MEILI_HOST=http://0.0.0.0:7700

-# REQUIRED FOR SEARCH: MeiliSearch HTTP Address, mainly for docker-compose to expose the search server. 
-# Replace '0.0.0.0' with 'meilisearch' if serving MeiliSearch with docker-compose. 
+# REQUIRED FOR SEARCH: MeiliSearch HTTP Address, mainly for docker-compose to expose the search server.
+# Replace '0.0.0.0' with 'meilisearch' if serving MeiliSearch with docker-compose.
 MEILI_HTTP_ADDR=0.0.0.0:7700

-# REQUIRED FOR SEARCH: In production env., a secure key is needed. You can generate your own. 
-# This master key must be at least 16 bytes, composed of valid UTF-8 characters. 
-# MeiliSearch will throw an error and refuse to launch if no master key is provided, 
+# REQUIRED FOR SEARCH: In production env., a secure key is needed. You can generate your own.
+# This master key must be at least 16 bytes, composed of valid UTF-8 characters.
+# MeiliSearch will throw an error and refuse to launch if no master key is provided,
 # or if it is under 16 bytes. MeiliSearch will suggest a secure autogenerated master key.
 # Using docker, it seems recognized as production so use a secure key.
 # This is a ready made secure key for docker-compose, you can replace it with your own.
@ -439,8 +442,8 @@ DISCORD_CALLBACK_URL=/oauth/discord/callback # this should be the same for every
 # Application Domains
 ###########################

-# Note: 
-# Server = Backend 
+# Note:
+# Server = Backend
 # Client = Public (the client is the url you visit)
 # For the Google login to work in dev mode, you will need to change DOMAIN_SERVER to localhost:3090 or place it in .env.development

@ -451,9 +454,16 @@ DOMAIN_SERVER=http://localhost:3080
 # Email
 ###########################

-# Email is used for password reset. Note that all 4 values must be set for email to work.
-# Failing to set the 4 values will result in LibreChat using the unsecured password reset!
-EMAIL_SERVICE=   # eg. gmail
-EMAIL_USERNAME=  # eg. your email address if using gmail
-EMAIL_PASSWORD=  # eg. this is the "app password" if using gmail
-EMAIL_FROM=noreply@librechat.ai # email address for from field, it is required to set a value here even in the cases where it's not porperly working.
+# Email is used for password reset. Note that all either service or host, username and password and the From address must be set for email to work.
+# Do NOT set the extended connection parameters (HOST, PORT, ENCRYPTION, ENCRYPTION_HOSTNAME, ALLOW_SELFSIGNED) if using EMAIL_SERVICE.
+# Failing to set valid values here will result in LibreChat using the unsecured password reset!
+EMAIL_SERVICE=                  # eg. gmail - see https://community.nodemailer.com/2-0-0-beta/setup-smtp/well-known-services/
+EMAIL_HOST=                     # eg. example.com - if EMAIL_SERVICE is not set, connect to this server.
+EMAIL_PORT=25                   # eg. 25 - mail server port to connect to with EMAIL_HOST (usually 25, 465, 587)
+EMAIL_ENCRYPTION=               # eg. starttls - valid values: starttls (force STARTTLS), tls (obligatory TLS), anything else (use STARTTLS if available)
+EMAIL_ENCRYPTION_HOSTNAME=      # eg. example.com - check the name in the certificate against this instead of EMAIL_HOST
+EMAIL_ALLOW_SELFSIGNED=         # eg. true - valid values: true (allow self-signed), anything else (disallow self-signed)
+EMAIL_USERNAME=                 # eg. me@gmail.com - the username used for authentication. For consumer services, this MUST usually match EMAIL_FROM.
+EMAIL_PASSWORD=                 # eg. password - the password used for authentication
+EMAIL_FROM_NAME=                # eg. LibreChat - the human-readable address in the From is constructed as "EMAIL_FROM_NAME <EMAIL_FROM>". Defaults to APP_TITLE.
+EMAIL_FROM=noreply@librechat.ai # eg. noreply@librechat.ai - mail address for from field. It is REQUIRED to set a value here even in if it's not porperly working!