Skip to content

Latest commit

 

History

History
876 lines (622 loc) · 34.9 KB

dotenv.md

File metadata and controls

876 lines (622 loc) · 34.9 KB
title description weight
⚙️ Environment Variables
Comprehensive guide for configuring your application's environment with the `.env` file. This document is your one-stop resource for understanding and customizing the environment variables that will shape your application's behavior in different contexts.
-11

.env File Configuration

Welcome to the comprehensive guide for configuring your application's environment with the .env file. This document is your one-stop resource for understanding and customizing the environment variables that will shape your application's behavior in different contexts.

While the default settings provide a solid foundation for a standard docker installation, delving into this guide will unveil the full potential of LibreChat. This guide empowers you to tailor LibreChat to your precise needs. Discover how to adjust language model availability, integrate social logins, manage the automatic moderation system, and much more. It's all about giving you the control to fine-tune LibreChat for an optimal user experience.

Reminder: Please restart LibreChat for the configuration changes to take effect

Alternatively, you can create a new file named docker-compose.override.yml in the same directory as your main docker-compose.yml file for LibreChat, where you can set your .env variables as needed under environment, or modify the default configuration provided by the main docker-compose.yml, without the need to directly edit or duplicate the whole file.

For more info see:

Server Configuration

Customization

  • Here you can change the app title and footer
  • Uncomment to add a custom footer.
    • Uncomment and make empty "" to remove the footer.
APP_TITLE=LibreChat
CUSTOM_FOOTER="My custom footer"

Port

  • 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.
HOST=localhost
PORT=3080

MongoDB Database

  • Change this to your MongoDB URI if different. You should also add LibreChat or your own APP_TITLE as the database name in the URI. For example:
    • if you are using docker, the URI format is mongodb://<ip>:<port>/<database>. Your MONGO_URI should look like this: mongodb://127.0.0.1:27018/LibreChat
    • if you are using an online db, the URI format is mongodb+srv://<username>:<password>@<host>/<database>?<options>. Your MONGO_URI should look like this: mongodb+srv://username:[email protected]/LibreChat?retryWrites=true (retryWrites=true is the only option you need when using the online db)
  • Instruction on how to create an online MongoDB database (useful for use without docker):
  • Securely access your docker MongoDB database: 
MONGO_URI=mongodb://127.0.0.1:27018/LibreChat

Application Domains

  • To use LibreChat locally, set DOMAIN_CLIENT and DOMAIN_SERVER to http://localhost:3080 (3080 being the port previously configured)
  • When deploying LibreChat to a custom domain, set DOMAIN_CLIENT and DOMAIN_SERVER to your deployed URL, e.g. https://librechat.example.com
DOMAIN_CLIENT=http://localhost:3080
DOMAIN_SERVER=http://localhost:3080

Prevent Public Search Engines Indexing

By default, your website will not be indexed by public search engines (e.g. Google, Bing, …). This means that people will not be able to find your website through these search engines. If you want to make your website more visible and searchable, you can change the following setting to false

NO_INDEX=true

❗Note: This method is not guaranteed to work for all search engines, and some search engines may still index your website or web page for other purposes, such as caching or archiving. Therefore, you should not rely solely on this method to protect sensitive or confidential information on your website or web page.

Logging

LibreChat has built-in central logging, see Logging System for more info.

  • Debug logging is enabled by default and crucial for development.
  • To report issues, reproduce the error and submit logs from ./api/logs/debug-%DATE%.log at: LibreChat GitHub Issues
  • Error logs are stored in the same location.
  • Keep debug logs active by default or disable them by setting DEBUG_LOGGING=false in the environment variable.
  • For more information about this feature, read our docs: Logging System
DEBUG_LOGGING=true
  • Enable verbose server output in the console with DEBUG_CONSOLE=TRUE, though it's not recommended due to high verbosity.
DEBUG_CONSOLE=false

This is not recommend, however, as the outputs can be quite verbose, and so it's disabled by default.

Permission

UID and GID are numbers assigned by Linux to each user and group on the system. If you have permission problems, set here the UID and GID of the user running the docker compose command. The applications in the container will run with these uid/gid.

UID=1000
GID=1000

Endpoints

In this section you can configure the endpoints and models selection, their API keys, and the proxy and reverse proxy settings for the endpoints that support it.

General Config

  • Uncomment ENDPOINTS to customize the available endpoints in LibreChat
  • PROXY is to be used by all endpoints (leave blank by default)
ENDPOINTS=openAI,assistants,azureOpenAI,bingAI,chatGPTBrowser,google,gptPlugins,anthropic
PROXY=

Anthropic

see: Anthropic Endpoint

  • You can request an access key from https://console.anthropic.com/
  • Leave ANTHROPIC_API_KEY= blank to disable this endpoint
  • Set ANTHROPIC_API_KEY= to "user_provided" to allow users to provide their own API key from the WebUI
  • If you have access to a reverse proxy for Anthropic, you can set it with ANTHROPIC_REVERSE_PROXY=
    • leave blank or comment it out to use default base url
ANTHROPIC_API_KEY=user_provided
ANTHROPIC_MODELS=claude-1,claude-instant-1,claude-2
ANTHROPIC_REVERSE_PROXY=

Azure

Important: See the complete Azure OpenAI setup guide for thorough instructions on enabling Azure OpenAI

  • To use Azure with this project, set the following variables. These will be used to build the API URL.
AZURE_API_KEY=
AZURE_OPENAI_API_INSTANCE_NAME=
AZURE_OPENAI_API_DEPLOYMENT_NAME=
AZURE_OPENAI_API_VERSION=
AZURE_OPENAI_API_COMPLETIONS_DEPLOYMENT_NAME=
AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME=

Note: As of 2023-11-10, the Azure API only allows one model per deployment,

  • 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 to the models available in your instance/deployment.

Note: AZURE_OPENAI_API_COMPLETIONS_DEPLOYMENT_NAME and AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME are optional but might be used in the future

  • It's recommended to name your deployments after the model name, e.g. gpt-35-turbo, which allows for fast deployment switching and AZURE_USE_MODEL_AS_DEPLOYMENT_NAME enabled. 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 base URL for Azure OpenAI API requests can be dynamically configured.

# .env file
AZURE_OPENAI_BASEURL=https://${INSTANCE_NAME}.openai.azure.com/openai/deployments/${DEPLOYMENT_NAME}

# Cloudflare example
AZURE_OPENAI_BASEURL=https://gateway.ai.cloudflare.com/v1/ACCOUNT_TAG/GATEWAY/azure-openai/${INSTANCE_NAME}/${DEPLOYMENT_NAME}

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
  • This enables the use of the model name as the deployment name, e.g. "gpt-3.5-turbo" as the deployment name (Advanced)
AZURE_USE_MODEL_AS_DEPLOYMENT_NAME=TRUE
  • To use Azure with the Plugins endpoint, you need the variables above, and uncomment the following variable:

Note: This may not work as expected and Azure OpenAI may not support OpenAI Functions yet Omit/leave it commented to use the default OpenAI API

PLUGINS_USE_AZURE="true"

** Generate images with Azure OpenAI Service**

  • For DALL-E-3:
DALLE3_AZURE_API_VERSION=the-api-version # e.g.: 2023-12-01-preview
DALLE3_BASEURL=https://<AZURE_OPENAI_API_INSTANCE_NAME>.openai.azure.com/openai/deployments/<DALLE3_DEPLOYMENT_NAME>/
DALLE3_API_KEY=your-azure-api-key-for-dall-e-3
  • For DALL-E-2:
DALLE2_AZURE_API_VERSION=the-api-version # e.g.: 2023-12-01-preview
DALLE2_BASEURL=https://<AZURE_OPENAI_API_INSTANCE_NAME>.openai.azure.com/openai/deployments/<DALLE2_DEPLOYMENT_NAME>/
DALLE2_API_KEY=your-azure-api-key-for-dall-e-2

BingAI

Bing, also used for Sydney, jailbreak, and Bing Image Creator, see: Bing Access token and Bing Jailbreak

  • Follow these instructions to get your bing access token (it's best to use the full cookie string for that purpose): Bing Access Token
  • Leave BINGAI_TOKEN= blank to disable this endpoint
  • Set BINGAI_TOKEN= to "user_provided" to allow users to provide their own API key from the WebUI

Note: It is recommended to leave it as "user_provided" and provide the token from the WebUI.

  • BINGAI_HOST can be necessary for some people in different countries, e.g. China (https://cn.bing.com). Leave it blank or commented out to use default server.
BINGAI_TOKEN=user_provided
BINGAI_HOST=

ChatGPT

see: ChatGPT Free Access token

Warning: To use this endpoint you'll have to set up your own reverse proxy. Here is the installation guide to deploy your own (based on Ninja): Ninja Deployment Guide

CHATGPT_REVERSE_PROXY=<YOUR-REVERSE-PROXY>

Note: If you're a GPT plus user you can try adding gpt-4, 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

This method might only works with text-davinci-002-render-sha and might stop working at any moment.

  • Leave CHATGPT_TOKEN= blank to disable this endpoint
  • Set CHATGPT_TOKEN= to "user_provided" to allow users to provide their own API key from the WebUI
    • It is not recommended to provide your token in the .env file since it expires often and sharing it could get you banned.
CHATGPT_TOKEN=
CHATGPT_MODELS=text-davinci-002-render-sha

Google

Follow these instructions to setup the Google Endpoint

GOOGLE_KEY=user_provided
GOOGLE_REVERSE_PROXY=
  • Customize the available models, separated by commas, without spaces.
    • The first will be default.
    • Leave it blank or commented out to use internal settings (default: all listed below).
# all available models as of 12/16/23
GOOGLE_MODELS=gemini-pro,gemini-pro-vision,chat-bison,chat-bison-32k,codechat-bison,codechat-bison-32k,text-bison,text-bison-32k,text-unicorn,code-gecko,code-bison,code-bison-32k

OpenAI

  • To get your OpenAI API key, you need to:

  • Leave OPENAI_API_KEY= blank to disable this endpoint

  • Set OPENAI_API_KEY= to "user_provided" to allow users to provide their own API key from the WebUI

OPENAI_API_KEY=user_provided
  • You can specify which organization to use for each API request to OpenAI. However, it is not required if you are only part of a single organization or intend to use your default organization. You can check your default organization here. This can also help you limit your LibreChat instance from allowing API keys outside of your organization to be used, as a mismatch between key and organization will throw an API error.
# Optional
OPENAI_ORGANIZATION=org-Y6rfake63IhVorgqfPQmGmgtId
  • Set to true to enable debug mode for the OpenAI endpoint
DEBUG_OPENAI=false
  • Customize the available models, separated by commas, without spaces.
    • The first will be default.
    • Leave it blank or commented out to use internal settings.
OPENAI_MODELS=gpt-3.5-turbo-0125,gpt-3.5-turbo-0301,gpt-3.5-turbo,gpt-4,gpt-4-0613,gpt-4-vision-preview,gpt-3.5-turbo-0613,gpt-3.5-turbo-16k-0613,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview,gpt-3.5-turbo-1106,gpt-3.5-turbo-instruct,gpt-3.5-turbo-instruct-0914,gpt-3.5-turbo-16k
  • Titling is enabled by default when initiating a conversation.
    • Set to false to disable this feature.
TITLE_CONVO=true
  • The default model used for titling by is gpt-3.5-turbo. You can change it by uncommenting the following and setting the desired model. (Optional)

Note: Must be compatible with the OpenAI Endpoint.

OPENAI_TITLE_MODEL=gpt-3.5-turbo
  • Enable message summarization by uncommenting the following (Optional/Experimental)

Note: this may affect response time when a summary is being generated.

OPENAI_SUMMARIZE=true

Experimental: We are using the ConversationSummaryBufferMemory method to summarize messages. To learn more about this, see this article: https://www.pinecone.io/learn/series/langchain/langchain-conversational-memory/

Important: As of v0.6.6, it's recommend you use the librechat.yaml Configuration file (guide here) to add Reverse Proxies as separate endpoints.

OPENAI_REVERSE_PROXY=
  • Sometimes when using Local LLM APIs, you may need to force the API to be called with a prompt payload instead of a messages payload; to mimic the /v1/completions request instead of /v1/chat/completions. This may be the case for LocalAI with some models. To do so, uncomment the following (Advanced)
OPENAI_FORCE_PROMPT=true

Assistants

  • The Assistants API by OpenAI has a dedicated endpoint.

  • To get your OpenAI API key, you need to:

    • Go to https://platform.openai.com/account/api-keys
    • Create an account or log in with your existing one
    • Add a payment method to your account (this is not free, sorry 😬)
    • Copy your secret key (sk-...) to ASSISTANTS_API_KEY

  • Leave ASSISTANTS_API_KEY= blank to disable this endpoint

  • Set ASSISTANTS_API_KEY= to user_provided to allow users to provide their own API key from the WebUI

  • Customize the available models, separated by commas, without spaces.

    • The first will be default.
    • Leave it blank or commented out to use internal settings:
      • The models list will be fetched from OpenAI but only Assistants-API-compatible models will be shown; at the time of writing, they are as shown in the example below.
ASSISTANTS_MODELS=gpt-3.5-turbo-0125,gpt-3.5-turbo-16k-0613,gpt-3.5-turbo-16k,gpt-3.5-turbo,gpt-4,gpt-4-0314,gpt-4-32k-0314,gpt-4-0613,gpt-3.5-turbo-0613,gpt-3.5-turbo-1106,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview
  • If necessary, you can also set an alternate base URL instead of the official one with ASSISTANTS_BASE_URL, which is similar to the OpenAI counterpart OPENAI_REVERSE_PROXY
ASSISTANTS_BASE_URL=http://your-alt-baseURL:3080/

  • If you have previously set the ENDPOINTS value in your .env file, you will need to add the value assistants

  • There is additional, optional configuration, depending on your needs, such as disabling the assistant builder UI, and determining which assistants can be used, that are available via the librechat.yaml custom config file.

OpenRouter

See OpenRouter for more info.

  • OpenRouter is a legitimate proxy service to a multitude of LLMs, both closed and open source, including: OpenAI models, Anthropic models, Meta's Llama models, pygmalionai/mythalion-13b and many more open source models. Newer integrations are usually discounted, too!

Note: this overrides the OpenAI and Plugins Endpoints.

OPENROUTER_API_KEY=

Plugins

Here are some useful documentation about plugins:

General Configuration:

  • Identify the available models, separated by commas without spaces. The first model in the list will be set as default. Leave it blank or commented out to use internal settings.
PLUGIN_MODELS=gpt-4,gpt-4-turbo-preview,gpt-4-0125-preview,gpt-4-1106-preview,gpt-4-0613,gpt-3.5-turbo,gpt-3.5-turbo-0125,gpt-3.5-turbo-1106,gpt-3.5-turbo-0613
  • Set to false or comment out to disable debug mode for plugins
DEBUG_PLUGINS=true
  • For securely storing credentials, you need a fixed key and IV. You can set them here for prod and dev environments.
    • You need a 32-byte key (64 characters in hex) and 16-byte IV (32 characters in hex) You can use this replit to generate some quickly: Key Generator

Warning: If you don't set them, the app will crash on startup.

CREDS_KEY=f34be427ebb29de8d88c107a71546019685ed8b241d8f2ed00c3df97ad2566f0
CREDS_IV=e2341419ec3dd3d19b13a1a87fafcbfb

Azure AI Search

This plugin supports searching Azure AI Search for answers to your questions. See: Azure AI Search

AZURE_AI_SEARCH_SERVICE_ENDPOINT=
AZURE_AI_SEARCH_INDEX_NAME=
AZURE_AI_SEARCH_API_KEY=

AZURE_AI_SEARCH_API_VERSION=
AZURE_AI_SEARCH_SEARCH_OPTION_QUERY_TYPE=
AZURE_AI_SEARCH_SEARCH_OPTION_TOP=
AZURE_AI_SEARCH_SEARCH_OPTION_SELECT=

DALL-E:

Note: Make sure the gptPlugins endpoint is set in the ENDPOINTS environment variable if it was configured before.

API Keys:

  • DALLE_API_KEY: This environment variable is intended for storing the OpenAI API key that grants access to both DALL-E 2 and DALL-E 3 services. Typically, this key should be kept private. If you are distributing a plugin or software that integrates with DALL-E, you may choose to leave this commented out, requiring the end user to input their own API key. If you have a shared API key you want to distribute with your software (not recommended for security reasons), you can uncomment this and provide the key.
DALLE_API_KEY=
  • DALLE3_API_KEY and DALLE2_API_KEY: These are similar to the above but are specific to each version of DALL-E. They allow for separate keys for DALL-E 2 and DALL-E 3, providing flexibility if you have different access credentials or subscription levels for each service.
DALLE3_API_KEY=
DALLE2_API_KEY=

System Prompts:

  • DALLE3_SYSTEM_PROMPT and DALLE2_SYSTEM_PROMPT: These variables allow users to set system prompts that can preconfigure or guide the image generation process for DALL-E 3 and DALL-E 2, respectively. Use these to set default prompts or special instructions that affect how the AI interprets the user's input prompts.
DALLE3_SYSTEM_PROMPT="Your DALL-E-3 System Prompt here"
DALLE2_SYSTEM_PROMPT="Your DALL-E-2 System Prompt here"

Reverse Proxy Settings:

  • DALLE_REVERSE_PROXY: This setting enables the specification of a reverse proxy for DALL-E API requests. This can be useful for routing traffic through a specific server, potentially for purposes like caching, logging, or adding additional layers of security. Ensure that the URL follows the required pattern and is appropriately configured to handle DALL-E requests.
DALLE_REVERSE_PROXY=

Base URLs:

  • DALLE3_BASEURL and DALLE2_BASEURL: These variables define the base URLs for DALL-E 3 and DALL-E 2 API endpoints, respectively. These might need to be set if you are using a custom proxy or a specific regional endpoint provided by OpenAI.
DALLE3_BASEURL=
DALLE2_BASEURL=

Azure OpenAI Integration (Optional):

  • DALLE3_AZURE_API_VERSION and DALLE2_AZURE_API_VERSION: If you are using Azure's OpenAI service to access DALL-E, these environment variables specify the API version for DALL-E 3 and DALL-E 2, respectively. Azure may have specific API version strings that need to be set to ensure compatibility with their services.
DALLE3_AZURE_API_VERSION=
DALLE2_AZURE_API_VERSION=

Remember to replace placeholder text such as "Your DALL-E-3 System Prompt here" with actual prompts or instructions and provide your actual API keys if you choose to include them directly in the file (though managing sensitive keys outside of the codebase is a best practice). Always review and respect OpenAI's usage policies when embedding API keys in software.

Note: if you have PROXY set, it will be used for DALL-E calls also, which is universal for the app

Google Search

See detailed instructions here: Google Search

GOOGLE_API_KEY=
GOOGLE_CSE_ID=

SerpAPI

SerpApi is a real-time API to access Google search results (not as performant)

SERPAPI_API_KEY=

Stable Diffusion (Automatic1111)

See detailed instructions here: Stable Diffusion

  • Use http://127.0.0.1:7860 with local install and http://host.docker.internal:7860 for docker
SD_WEBUI_URL=http://host.docker.internal:7860

Tavily

Get your API key here: https://tavily.com/#api

TAVILY_API_KEY=

WolframAlpha

See detailed instructions here: Wolfram Alpha

WOLFRAM_APP_ID=

Zapier

  • You need a Zapier account. Get your API key from here: Zapier
  • Create allowed actions - Follow step 3 in this getting start guide from Zapier

Note: zapier is known to be finicky with certain actions. Writing email drafts is probably the best use of it.

ZAPIER_NLA_API_KEY=

Search (Meilisearch)

Enables search in messages and conversations:

SEARCH=true

Note: If you're not using docker, it requires the installation of the free self-hosted Meilisearch or a paid remote plan

To disable anonymized telemetry analytics for MeiliSearch for absolute privacy, set to true:

MEILI_NO_ANALYTICS=true

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

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. This is a ready made secure key for docker-compose, you can replace it with your own.

MEILI_MASTER_KEY=DrhYf7zENyR6AlUCKmnz0eYASOQdl6zxH7s7MKFSfFCt

User System

This section contains the configuration for:

Moderation

The Automated Moderation System uses a scoring mechanism to track user violations. As users commit actions like excessive logins, registrations, or messaging, they accumulate violation scores. Upon reaching a set threshold, the user and their IP are temporarily banned. This system ensures platform security by monitoring and penalizing rapid or suspicious activities.

see: Automated Moderation

Basic Moderation Settings

  • OPENAI_MODERATION: Set to true or false, Whether or not to enable OpenAI moderation on the OpenAI and Plugins endpoints
  • OPENAI_MODERATION_API_KEY: Your OpenAI API key
  • OPENAI_MODERATION_REVERSE_PROXY: Note: Commented out by default, this is not working with all reverse proxys
OPENAI_MODERATION=false
OPENAI_MODERATION_API_KEY=
OPENAI_MODERATION_REVERSE_PROXY=
  • BAN_VIOLATIONS: Whether or not to enable banning users for violations (they will still be logged)
  • BAN_DURATION: How long the user and associated IP are banned for (in milliseconds)
  • BAN_INTERVAL: The user will be banned everytime their score reaches/crosses over the interval threshold
BAN_VIOLATIONS=true
BAN_DURATION=1000 * 60 * 60 * 2
BAN_INTERVAL=20

Score for each violation

LOGIN_VIOLATION_SCORE=1
REGISTRATION_VIOLATION_SCORE=1
CONCURRENT_VIOLATION_SCORE=1
MESSAGE_VIOLATION_SCORE=1
NON_BROWSER_VIOLATION_SCORE=20
ILLEGAL_MODEL_REQ_SCORE=5

Note: Non-browser access and Illegal model requests are almost always nefarious as it means a 3rd party is attempting to access the server through an automated script.

Login and registration rate limiting.

  • LOGIN_MAX: The max amount of logins allowed per IP per LOGIN_WINDOW
  • LOGIN_WINDOW: In minutes, determines the window of time for LOGIN_MAX logins
  • REGISTER_MAX: The max amount of registrations allowed per IP per REGISTER_WINDOW
  • REGISTER_WINDOW: In minutes, determines the window of time for REGISTER_MAX registrations
LOGIN_MAX=7
LOGIN_WINDOW=5
REGISTER_MAX=5
REGISTER_WINDOW=60

Message rate limiting (per user & IP)

  • LIMIT_CONCURRENT_MESSAGES: Whether to limit the amount of messages a user can send per request
  • CONCURRENT_MESSAGE_MAX: The max amount of messages a user can send per request
LIMIT_CONCURRENT_MESSAGES=true
CONCURRENT_MESSAGE_MAX=2

Limiters

Note: You can utilize both limiters, but default is to limit by IP only.

  • IP Limiter:
  • LIMIT_MESSAGE_IP: Whether to limit the amount of messages an IP can send per MESSAGE_IP_WINDOW
  • MESSAGE_IP_MAX: The max amount of messages an IP can send per MESSAGE_IP_WINDOW
  • MESSAGE_IP_WINDOW: In minutes, determines the window of time for MESSAGE_IP_MAX messages
LIMIT_MESSAGE_IP=true
MESSAGE_IP_MAX=40
MESSAGE_IP_WINDOW=1
  • User Limiter:
  • LIMIT_MESSAGE_USER: Whether to limit the amount of messages an IP can send per MESSAGE_USER_WINDOW
  • MESSAGE_USER_MAX: The max amount of messages an IP can send per MESSAGE_USER_WINDOW
  • MESSAGE_USER_WINDOW: In minutes, determines the window of time for MESSAGE_USER_MAX messages
LIMIT_MESSAGE_USER=false
MESSAGE_USER_MAX=40
MESSAGE_USER_WINDOW=1

Balance

The following enables user balances for the OpenAI/Plugins endpoints, which you can add manually or you will need to build out a balance accruing system for users.

see: Token Usage

  • To manually add balances, run the following command:npm run add-balance
    • You can also specify the email and token credit amount to add, e.g.:npm run add-balance [email protected] 1000
    • To list the balance of every user: npm run list-balances

Note: 1000 credits = $0.001 (1 mill USD)

  • Set to true to enable token credit balances for the OpenAI/Plugins endpoints
CHECK_BALANCE=false

Registration and Login

see: User/Auth System

image

  • General Settings:
    • ALLOW_EMAIL_LOGIN: Email login. Set to true or false to enable or disable ONLY email login.
    • ALLOW_REGISTRATION: Email registration of new users. Set to true or false to enable or disable Email registration.
    • ALLOW_SOCIAL_LOGIN: Allow users to connect to LibreChat with various social networks, see below. Set to true or false to enable or disable.
    • ALLOW_SOCIAL_REGISTRATION: Enable or disable registration of new user using various social network. Set to true or false to enable or disable.

Quick Tip: Even with registration disabled, add users directly to the database using npm run create-user. Quick Tip: With registration disabled, you can delete a user with npm run delete-user [email protected].

ALLOW_EMAIL_LOGIN=true
ALLOW_REGISTRATION=true
ALLOW_SOCIAL_LOGIN=false
ALLOW_SOCIAL_REGISTRATION=false
  • Default values: session expiry: 15 minutes, refresh token expiry: 7 days 
SESSION_EXPIRY=1000 * 60 * 15
REFRESH_TOKEN_EXPIRY=(1000 * 60 * 60 * 24) * 7
  • You should use new secure values. The examples given are 32-byte keys (64 characters in hex).
    • Use this replit to generate some quickly: JWT Keys
JWT_SECRET=16f8c0ef4a5d391b26034086c628469d3f9f497f08163ab9b40137092f2909ef
JWT_REFRESH_SECRET=eaa5191f2914e30b9387fd84e254e4ba6fc51b4654968a9b0803b456a54b8418

Social Logins

Discord Authentication

for more information: Discord

# Discord
DISCORD_CLIENT_ID=your_client_id
DISCORD_CLIENT_SECRET=your_client_secret
DISCORD_CALLBACK_URL=/oauth/discord/callback

Facebook Authentication

for more information: Facebook Authentication

# Facebook
FACEBOOK_CLIENT_ID=
FACEBOOK_CLIENT_SECRET=
FACEBOOK_CALLBACK_URL=/oauth/facebook/callback

GitHub Authentication

for more information: GitHub Authentication

# GitHub
GITHUB_CLIENT_ID=your_client_id
GITHUB_CLIENT_SECRET=your_client_secret
GITHUB_CALLBACK_URL=/oauth/github/callback

Google Authentication

for more information: Google Authentication

# Google
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GOOGLE_CALLBACK_URL=/oauth/google/callback

OpenID Authentication

for more information: Azure OpenID Authentication or AWS Cognito OpenID Authentication

# OpenID
OPENID_CLIENT_ID=
OPENID_CLIENT_SECRET=
OPENID_ISSUER=
OPENID_SESSION_SECRET=
OPENID_SCOPE="openid profile email"
OPENID_CALLBACK_URL=/oauth/openid/callback

OPENID_BUTTON_LABEL=
OPENID_IMAGE_URL=

Email Password Reset

Email is used for password reset. See: Email Password Reset

  • Note that all either service or host, username and password and the From address must be set for email to work.

If using EMAIL_SERVICE, do NOT set the extended connection parameters:

HOST, PORT, ENCRYPTION, ENCRYPTION_HOSTNAME, ALLOW_SELFSIGNED

Failing to set valid values here will result in LibreChat using the unsecured password reset!

See: nodemailer well-known-services

EMAIL_SERVICE=

If EMAIL_SERVICE is not set, connect to this server:

EMAIL_HOST=

Mail server port to connect to with EMAIL_HOST (usually 25, 465, 587, 2525):

EMAIL_PORT=25

Encryption valid values: starttls (force STARTTLS), tls (obligatory TLS), anything else (use STARTTLS if available):

EMAIL_ENCRYPTION=

Check the name in the certificate against this instead of EMAIL_HOST:

EMAIL_ENCRYPTION_HOSTNAME=

Set to true to allow self-signed, anything else will disallow self-signed:

EMAIL_ALLOW_SELFSIGNED=

Username used for authentication. For consumer services, this MUST usually match EMAIL_FROM:

EMAIL_USERNAME=

Password used for authentication:

EMAIL_PASSWORD=

The human-readable address in the From is constructed as EMAIL_FROM_NAME <EMAIL_FROM>. Defaults to APP_TITLE:

EMAIL_FROM_NAME=

Mail address for from field. It is REQUIRED to set a value here (even if it's not porperly working):

[email protected]

Other

  • Redis: Redis support is experimental, you may encounter some problems when using it.

If using Redis, you should flush the cache after changing any LibreChat settings

REDIS_URI=
USE_REDIS=
  • Birthday Hat: Give the AI Icon a Birthday Hat 🥳

Will show automatically on February 11th (LibreChat's birthday)

Set this to false to disable the birthday hat

Set to true to enable all the time.

SHOW_BIRTHDAY_ICON=true