LibreChat YAML Configuration Files

This repository provides YAML configuration files for LibreChat, enabling flexible and efficient configuration management.

---

Table of Contents

• LibreChat YAML Configuration Files
  • Table of Contents
  • Key Differences
  • Usage Guide
    • Basic Usage
    • Advanced Usage
  • RAW URLs
  • .ENV Configuration for Custom Endpoints
  • Update Policy
  • Validation and Formatting
  • Additional Resources

---

Key Differences

• librechat-env.yaml - Uses .env variables with the API key hardcoded in the .env file, making it suitable for single-user usage.
• librechat-user-provided.yaml – Allows users to manually input the API key via the LibreChat front end, suitable for multi-user environments.

---

Usage Guide

Basic Usage

1. Select a Configuration File
   Choose either librechat-env.yaml or librechat-user-provided.yaml.

2. Obtain the RAW URL
   Copy the RAW URL of the chosen file (see RAW URLs).

3. Edit Your .env File
   Locate your project’s .env file and open it for editing.

4. Update the CONFIG_PATH
   Uncomment the CONFIG_PATH line and replace <RAW_URL_GOES_HERE> with the copied URL:

   #===============#
   # Configuration #
   #===============#
   # Use an absolute path, a relative path, or a URL
   
   CONFIG_PATH=<RAW_URL_GOES_HERE>
   

5. Configure Your Custom Endpoints Environment Keys (for librechat-env.yaml only) Replace <ENV_GOES_HERE> with the provided .ENV Configuration for Custom Endpoints values:

   #===================================#
   # Known Endpoints - librechat.yaml  #
   #===================================#
   # See: https://www.librechat.ai/docs/configurationlibrechat_yamlai_endpoints
   
   <ENV_GOES_HERE>
   

6. Configure the Web Seach Environment Keys (for librechat-env.yaml only)

   #======================#
   # Web Search           #
   #======================#
   
   # Note: All of the following variable names can be customized.
   # Omit values to allow user to provide them.
   
   # For more information on configuration values, see:
   # https://librechat.ai/docs/features/web_search
   
   # Search Provider (Required)
   SERPER_KEY=Your_Serper_API_Key_Here
   
   # Scraper (Required)
   FIRECRAWL_KEY=Your_Firecrawl_API_Key_Here
   # Optional: Custom Firecrawl API URL
   # FIRECRAWL_API_URL=your_firecrawl_api_url
   
   # Reranker (Required)
   JINA_KEY=Your_Jina_API_Key_Here
   # or if you want to use Cohere,
   COHERE_KEY2=Your_Cohere2_API_Key_Here
   

Advanced Usage

1. Create a file named librechat.yaml at the project root (if it doesn’t exist already).
2. Copy and paste the entire content of one of the YAML configuration files into it.
3. Modify the configuration as needed.

---

RAW URLs

• librechat-env.yaml

  https://raw.githubusercontent.com/febryanvaldo/LibreChat/refs/heads/main/librechat-env.yaml
  

• librechat-user-provided.yaml

  https://raw.githubusercontent.com/febryanvaldo/LibreChat/refs/heads/main/librechat-user-provided.yaml
  

---

.ENV Configuration for Custom Endpoints

COHERE_KEY=Your_API_Key_Here
DEEPSEEK_KEY=Your_API_Key_Here
MISTRALAI_KEY=Your_API_Key_Here
PERPLEXITY_KEY=Your_API_Key_Here
XAI_KEY=Your_API_Key_Here
CEREBRAS_KEY=Your_API_Key_Here
GROQ_KEY=Your_API_Key_Here
SAMBANOVA_KEY=Your_API_Key_Here
CHUTES_KEY=Your_API_Key_Here
DEEPINFRA_KEY=Your_API_Key_Here
FIREWORKSAI_KEY=Your_API_Key_Here
FRIENDLIAI_KEY=Your_API_Key_Here
HYPERBOLIC_KEY=Your_API_Key_Here
KLUSTERAI_KEY=Your_API_Key_Here
NEBIUS_KEY=Your_API_Key_Here
NOVITAAI_KEY=Your_API_Key_Here
SHUTTLEAI_KEY=Your_API_Key_Here
SYNTHETIC_KEY=Your_API_Key_Here
TARGON_KEY=Your_API_Key_Here 
TOGETHERAI_KEY=Your_API_Key_Here
APIPIE_KEY=Your_API_Key_Here
NANOGPT_KEY=Your_API_Key_Here
OPENROUTER_KEY=Your_API_Key_Here
REQUESTY_KEY=Your_API_Key_Here

---

Update Policy

I strive to update the configuration on a daily basis. Stay tuned for new changes and improvements.

---

Validation and Formatting

To validate and format your YAML configuration files, you can use these online tools:

• Elmah YAML Formatter
• JSON Formatter YAML Validator

---

Additional Resources

For detailed documentation on LibreChat configuration, please see the LibreChat Custom Config Documentation.

---