Commit Graph

290 Commits

Author SHA1 Message Date
Dustin Healy
8dc29fd0ef 📚 docs: Add MCP reinitialization instructions and document new 'startup' Property for MCP servers (#358)
- Added `startup` field to MCP server configuration, allowing users to control server connection at application startup.
- Included instructions for reinitializing MCP servers with user credentials.
2025-07-22 22:54:25 -04:00
Dustin Healy
f0f07d24a7 📚 docs: Add firecrawlOptions configuration details to web search documentation (#360)
Co-authored-by: Danny Avila <danny@librechat.ai>
2025-07-22 22:54:17 -04:00
Dustin Healy
b8e656306c 📚 docs: Enhance MCP server management documentation (#365)
- Updated changelog for version 1.2.8 to include enhancements in MCP server management, such as connection status tracking and OAuth support.
- Added detailed documentation on connection status indicators, server initialization processes, and user interface improvements for managing MCP servers.
- Introduced new images and videos to illustrate the updated features and functionalities.
2025-07-22 22:53:00 -04:00
maryanmaykher65
e67d02a50a 📚 docs: clarify HELP_AND_FAQ_URL disable option (#339)
Co-authored-by: Maryan Maykher <maryan.maykher@un.org>
2025-07-21 17:43:15 -04:00
Sebastien Bruel
86a2ed54d7 📚 docs: Add documentation for ENABLE_IMAGE_OUTPUT_GZIP_SCAN environment variable (#353) 2025-07-21 17:42:45 -04:00
Dustin Healy
dfbd8cbd18 📚 docs: Update Preset Fields and Query Params (#361)
* 📘 docs: Enhance Model Specs documentation with new parameters and default values

- Updated Model Specs documentation to include new parameters: `reasoning_effort`, `reasoning_summary`, `useResponsesApi`, `web_search`, `disableStreaming`, `thinking`, and `thinkingBudget`.
- Added some default values for existing parameters
- Documented changes in changelog

* docs: change note on model params from 'numbers' to 'values' to account for new params that don't have numeric values
2025-07-21 17:41:22 -04:00
Marco Beretta
bc1ba654d0 feat: add companies in Landing (#350)
* feat: add companies in Landing

* feat: add Boston University logos with color variant
2025-07-10 12:09:29 +02:00
Rakshit
76e562e7ac 🖼️ docs: add clientImageResize configuration (#333) 2025-07-07 13:26:06 -04:00
Rakshit
6f9668db68 docs: add temporaryChatRetention configuration documentation (#334) 2025-07-07 13:24:56 -04:00
Dustin Healy
cb9eaf239b 📚 docs: Add MCP Servers configuration to interface documentation (#337)
* 📚 docs: Add MCP Servers configuration to interface documentation

- Introduced `mcpServers` field in the interface configuration with a placeholder for the MCP server selection dropdown.
- Updated example configurations and added detailed descriptions for the `mcpServers` key and its sub-key `placeholder` in the documentation.

* 📚 docs: Add docs update summary to config_v1.2.8 changelog

---------

Co-authored-by: Danny Avila <danny@librechat.ai>
2025-07-07 12:57:33 -04:00
Dustin Healy
8a4376fc17 📚 docs: Update Custom Endpoint docs with new user placeholder features for headers (#338) 2025-07-07 11:19:54 -04:00
Dustin Healy
8907e43abc 📚 docs: Add SearXNG Configuration and Setup Instructions for Web Search (#348)
- Introduced new environment variables for SearXNG: SEARXNG_INSTANCE_URL and SEARXNG_API_KEY.
- Updated documentation to include detailed setup instructions for configuring SearXNG with LibreChat.
- Added new images and a video guide to assist users in setting up and configuring SearXNG.
- Enhanced existing web search documentation to clarify the integration of SearXNG as a search provider
2025-07-07 11:19:22 -04:00
Dustin Healy
e621266b5c Revert "📚 docs: Add SearXNG Configuration and Setup Instructions for Web Search"
This reverts commit ed5ae74cc6.
2025-07-06 12:05:51 -07:00
Dustin Healy
ed5ae74cc6 📚 docs: Add SearXNG Configuration and Setup Instructions for Web Search
- Introduced new environment variables for SearXNG: SEARXNG_INSTANCE_URL and SEARXNG_API_KEY.
- Updated documentation to include detailed setup instructions for configuring SearXNG with LibreChat.
- Added new images and a video guide to assist users in setting up and configuring SearXNG.
- Enhanced existing web search documentation to clarify the integration of SearXNG as a search provider.
2025-07-06 12:03:52 -07:00
Peter V Cook
35c719e8f2 Update link to 2024 Roadmap to 2025 Roadmap (#343)
* Update link to 2024 Roadmap to 2025 Roadmap

* fix: update Roadmap link to point to 2025 roadmap

---------

Co-authored-by: Marco Beretta <81851188+berry-13@users.noreply.github.com>
2025-07-06 17:26:23 +02:00
Dustin Healy
5e6b7cca9c 📚 docs: Smithery Support for MCP (#342)
- Updated the MCP documentation to include detailed instructions for adding MCP servers using the smithery cli tool.
- Added new images to illustrate the steps for discovering and installing MCP servers through smithery.ai.
2025-07-05 12:34:27 -04:00
Ruben Talstra
e90054d8c4 feat: Add Uyghur, Latvian, and Armenian language support in translations (#346) 2025-07-03 10:46:47 -04:00
Danny Avila
5bec56610f 📘 feat: Update Agents, OCR, and MCP Docs with new Features (#336)
* 📚 docs: Update OCR documentation for clarity and structure

* 📚 docs: Add Model Context Protocol (MCP) documentation and update features

* 📚 docs: Add Model Context Protocol (MCP) section to features documentation

* 📚 docs: Enhance MCP documentation with OAuth authentication details and configuration examples

* 📚 docs: Update MCP documentation with improved configuration examples and OAuth authentication details

* 📚 docs: Update dotenv documentation to reflect new index header constants

* 📚 docs: Revise MCP integration documentation for Agents with clearer instructions and new images

- Updated the steps for adding MCP tools to agents for better clarity and organization.
- Introduced new images to illustrate the MCP tools interface.
- Removed outdated image and improved the overall structure of the documentation.

* 📚 docs: Enhance MCP documentation with custom user variables support

---------

Co-authored-by: Aleš Kůtek <kutekales@gmail.com>
2025-06-19 20:36:29 -04:00
Danny Avila
223d7513fe 📄 docs: Accurate Privacy, Terms of Service, and Cookie Policies (#330)
* 📄 docs: Accurate Privacy, Terms of Service, and Cookie Policies for LibreChat Docs

* 📄 docs: Update last updated dates in Cookie and Privacy Policies to June 13, 2025
2025-06-13 17:18:13 -04:00
Danny Avila
460241640e 📚 docs: Update Config to v1.2.8 and add Azure Mistral OCR Support (#329)
* 📚 docs: Update Config Version to v1.2.8 and add Azure Mistral OCR support

- Updated version numbers in multiple configuration files to reflect the new version 1.2.8.
- Introduced a new `azure_mistral_ocr` strategy option for OCR configuration, enabling the use of Mistral OCR models deployed on Azure AI Foundry.
- Enhanced documentation for OCR configuration to include details on Azure deployment and its requirements.
- Added changelog entries for version 1.2.8, summarizing the new features and updates.

* 📚 docs: Enhance changelog for v1.2.8 with MCP Servers updates

- Added `serverInstructions` to MCP Servers object structure, detailing its role in agent context.
- Introduced new dynamic user field placeholders for enhanced multi-user support, including `{{LIBRECHAT_USER_ID}}` and `{{LIBRECHAT_USER_*}}`.
- Updated documentation links for better navigation and clarity on MCP Servers object structure.

* 📚 docs: Update changelog and OCR documentation for v1.2.8

- Enhanced the changelog for v1.2.8 with additional details on user field placeholders in the MCP Servers object structure.
- Improved OCR documentation by linking strategies to their respective sections for better clarity and navigation.
- Noted the future implementation status of the custom OCR service in the documentation.
2025-06-13 17:13:57 -04:00
Ben Verhees
8608b05547 docs: MCP Server Instructions (#321) 2025-06-13 16:53:16 -04:00
Noah Ispas
0b64b4144b docs: update info about admin user (#324)
* update info about admin user

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* fix: typo, and corrections on notes

---------

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>
Co-authored-by: Danny Avila <danacordially@gmail.com>
2025-06-13 16:52:40 -04:00
Fffrank
7deb1259fa docs: Update 2024-03-22_unraid_guide.mdx (#327)
Changed replit URL to the internal Librechat tool I discovered while following this guide.  ;)
2025-06-13 16:52:03 -04:00
Danny Avila
ab24838675 📚 docs: MCP server Dynamic User Field Placeholders (#326)
- Updated the `mcp_servers.mdx` and `agents.mdx` files to include dynamic user field placeholders for headers, URLs, and environment variables.
- Added detailed descriptions and examples for user field placeholders such as `{{LIBRECHAT_USER_EMAIL}}`, `{{LIBRECHAT_USER_ROLE}}`, and others.
- Improved clarity on the usage of environment variables and their integration with user-specific data.
2025-06-11 17:05:57 -04:00
Danny Avila
9908957284 🧠 fix: Memory-related Docs 2025-06-10 18:58:12 -04:00
Danny Avila
47a5e96d21 🧠 feat: Memories + Documentation Guidelines (#322)
* feat: memories update

* docs: Add LibreChat documentation rules and configuration update guidelines

* docs: Update Node.js version requirements across documentation

- Revised Node.js prerequisites to specify v20.19.0+ (or ^22.12.0 or >= 23.0.0) in README.md, get_started.mdx, npm.mdx, docker_linux.mdx, and nginx.mdx for clarity and compatibility with openid-client v6.

* docs: Add DEBUG_OPENID_REQUESTS environment variable for enhanced OpenID debugging

- Introduced a new environment variable, DEBUG_OPENID_REQUESTS, to enable detailed logging of OpenID request headers for better troubleshooting.
- Updated documentation to include troubleshooting steps for OpenID Connect, emphasizing the use of the new logging feature.

* docs: Update changelog dates for versions v1.2.6 and v1.2.7

* docs: Enhance memory configuration documentation

- Updated the memory configuration section to clarify the default value for the personalize option.
- Changed the provider name from "openai" to "openAI" for consistency.
- Added notes regarding the provider field and valid model parameters.
- Improved examples for memory agent configuration.
2025-06-10 12:54:33 -04:00
Danny Avila
6b471cf18c 📝 docs: Update roadmap deadline for Admin Panel (#319) 2025-06-06 12:06:48 -04:00
Danny Avila
103ed0fffa 📧 docs: Mailgun API Email Configuration (#317)
* 📧 docs: Mailgun API email configuration

* 📝 docs: Update agents configuration note to include custom endpoint option
2025-06-04 14:20:18 -04:00
Ruben Talstra
0d937e564c 🔒 feat: cloudflare turnstile (#245)
* feat: Add Cloudflare Turnstile configuration support and documentation

* feat: Add Cloudflare Turnstile configuration section to documentation
2025-05-29 14:38:12 -04:00
tsutsu3
d03529d00c 🔑 feat: SAML authentication (#255)
* Add env doc

* Fix registration note

* Add saml docs

* Fix typo

* Update saml docs

* Update saml auth0

* Remove default value for SAML button label

---------

Co-authored-by: Danny Avila <danny@librechat.ai>
2025-05-29 14:26:11 -04:00
rmarable-flaretx
520c77ee0e docs: helm_chart.mdx (#314)
Updated the documentation to improve readability.
2025-05-29 14:05:02 -04:00
Marco Beretta
fc2296a459 feat: add imageGeneration param (#311)
* Update file_config.mdx

* Update file_config.mdx
2025-05-27 22:21:19 +02:00
Danny Avila
6fa8a6daa2 🔍 docs: Web Search (#309)
* feat: Introduce web search functionality in configuration v1.2.6

- Added `webSearch` configuration to manage web search features, including search providers, scrapers, and rerankers.
- Implemented a toggle for `webSearch` in the interface configuration to control visibility in the chat interface.
- Updated agents configuration to include `web_search` capability, enabling web search for agents by default.
- Created detailed documentation for web search configuration and usage, including API key setup and component descriptions.

* feat: Add web search feature documentation and update configuration

- Introduced a new section for the web search feature in the documentation, detailing its capabilities and configuration options.
- Updated the `_meta.ts` file to include the web search entry.
- Enhanced the web search configuration instructions to emphasize the importance of using environment variable names instead of actual API keys in the YAML file.

* fix: Correct clip-path attribute to clipPath in RossIndex component

* docs: Expand web search feature documentation

- Added detailed information about the web search feature, including environment variable customization options.
- Included a table of required API keys for various search providers and services.
- Emphasized the ability to customize variable names in the `librechat.yaml` configuration file.

* docs: Update web search configuration settings

- Changed default `scraperTimeout` from 30000ms to 7500ms in the documentation.
- Updated `safeSearch` option to reflect new values: 0 (OFF), 1 (MODERATE - default), and 2 (STRICT).
- Enhanced descriptions for both settings to clarify their functionality and defaults.
2025-05-24 10:29:32 -04:00
Ryan Adler
226efd990d docs: Corrected example for TRUST_PROXY (#298) 2025-05-23 17:31:38 -04:00
Danny Avila
c7cbb93bfe docs: Add OpenID Connect token reuse feature documentation (#308)
- Introduced a new section on reusing access and refresh tokens from OpenID Connect providers, specifically for Azure Entra ID.
- Added detailed configuration steps and environment variables for enabling token reuse.
- Created a dedicated page for "Re-use OpenID Tokens for Login Session" with prerequisites and troubleshooting tips.
- Updated existing documentation to reference the new token reuse feature.
2025-05-23 17:16:29 -04:00
Theo N. Truong
b6a5b6869d feat: Customize Endpoint Parameters (#297) 2025-05-20 09:31:59 -04:00
hofq
93ae131c82 📊 docs: helm chart 2.x initial (#231)
* helm chart 2.x initial docs

* Update pages/docs/local/helm_chart.mdx

Co-authored-by: Noah Ispas <Noahispas@gmail.com>

* Update pages/docs/local/helm_chart.mdx

Co-authored-by: Noah Ispas <Noahispas@gmail.com>

---------

Co-authored-by: Ruben Talstra <RubenTalstra1211@outlook.com>
Co-authored-by: Noah Ispas <Noahispas@gmail.com>
2025-05-17 15:53:42 -04:00
Wesley Deal
84474f84c7 📜 docs: clarify agent admin controls, instruct on how to add admins (#293) 2025-05-15 11:59:37 -04:00
Ben Verhees
8c023e816f 📜 docs: Add documentation for MCP Streamable HTTP transport (#299) 2025-05-15 11:57:30 -04:00
Ruben Talstra
cde41874b9 feat: Add Danish and Czech and Catalan language support in translations (#302)
* feat: Add Czech and Danish language support in translations

* feat: Update index.mdx to include Catalan language support in translations
2025-05-14 13:07:53 -04:00
Danny Avila
3d223aba1f v0.7.8 (#295)
* chore: officially deprecate `endpointsMenu`

* feat: add `chatMenu` option to MCP server configuration for dropdown visibility control

* chore: add missing `timeout` and `initTimeout` options to MCP server configuration

* chore: add Authorization header example to MCP server configuration

* Config v1.2.5

* chore: remove plugins configuration from Azure OpenAI documentation

* feat: add vLLM configuration documentation

* feat: add changelog for LibreChat v0.7.8 and update config date to 2025/5/7
2025-05-08 15:17:02 -04:00
Odrec
f7dc16f095 🦙 docs: ollama.mdx (#278)
The baseURL option should not have the /chat/completions part for Ollama models to work with Agents.
2025-05-08 14:41:26 -04:00
Danny Avila
c42a41810e v0.7.8-rc1 (#292)
* docs: Enhance MCP server documentation with multi-user support details and example configuration

*  v0.7.8-rc1

* feat: Add changelog for v0.7.7-rc1 and update v0.7.8-rc1 to remove ogImage

* docs: Update new contributors section in changelog for v0.7.8-rc1

* docs: Remove idleTimeout from MCP server configuration examples for clarity

* chore: Remove template pricing page and related metadata for simplification
2025-04-30 09:35:26 -04:00
Danny Avila
54be404f39 hotfix: remove termly as it is blocking resources 2025-04-28 14:35:55 -04:00
Danny Avila
3b0d59de41 docs: Clarify image editing tool usage and parameter descriptions in image generation documentation 2025-04-27 14:02:46 -04:00
Danny Avila
9602d4aaff docs: Update Azure OpenAI setup instructions and remove redundant API key note 2025-04-27 13:54:38 -04:00
Danny Avila
968ed4e11a docs: Update image generation and editing documentation for clarity on context and image ID usage 2025-04-26 03:48:17 -04:00
Danny Avila
ca672b846b feat: RAG Blog post (#291)
* Create optimizing-rag-performance-in-librechat.md

This PR adds a detailed blog post written by Henk van Ess that covers how to optimize Retrieval-Augmented Generation (RAG) performance in LibreChat.

The guide walks through:

Improving vector database performance (PostgreSQL/pgvector)
Chunking strategies (CHUNK_SIZE / CHUNK_OVERLAP)
Embedding provider options (OpenAI, Azure, Ollama)
Retrieval settings (RAG_API_TOP_K)
Monitoring and server resource tips
It's designed to help developers fine-tune their LibreChat instances for speed and quality. All content is based on hands-on testing and is Markdown-formatted for blog use.

Looking forward to feedback — happy to revise if needed!

* Update optimizing-rag-performance-in-librechat.md

This PR adds a detailed blog post written by Henk van Ess that covers how to optimize Retrieval-Augmented Generation (RAG) performance in LibreChat.

The guide walks through:

Improving vector database performance (PostgreSQL/pgvector)
Chunking strategies (CHUNK_SIZE / CHUNK_OVERLAP)
Embedding provider options (OpenAI, Azure, Ollama)
Retrieval settings (RAG_API_TOP_K)
Monitoring and server resource tips
It's designed to help developers fine-tune their LibreChat instances for speed and quality. All content is based on hands-on testing and is Markdown-formatted for blog use.

Looking forward to feedback — happy to revise if needed!

* Optimizing-rag-performance-in-librechat.md

This PR adds a detailed blog post written by Henk van Ess that covers how to optimize Retrieval-Augmented Generation (RAG) performance in LibreChat.

The guide walks through:

Improving vector database performance (PostgreSQL/pgvector)
Chunking strategies (CHUNK_SIZE / CHUNK_OVERLAP)
Embedding provider options (OpenAI, Azure, Ollama)
Retrieval settings (RAG_API_TOP_K)
Monitoring and server resource tips
It's designed to help developers fine-tune their LibreChat instances for speed and quality. All content is based on hands-on testing and is Markdown-formatted for blog use.

Looking forward to feedback — happy to revise if needed!

* docs: Document AWS_ENDPOINT_URL for S3 configuration (#285)

This commit updates the documentation related to S3 storage configuration to include the `AWS_ENDPOINT_URL` environment variable. This variable was introduced in PR [#6431](https://github.com/danny-avila/LibreChat/pull/6431) to allow users to specify a custom endpoint URL for S3 connections, but the documentation is not update.

The changes include:
- Adding a description for `AWS_ENDPOINT_URL`, clarifying its purpose and indicating that it's optional.

* 🎨 feat: Adds Image Gen Docs, fix broken links, usage stats, missing .env vars, formatting issues, bump Next.js (#288)

* docs: enhance API key setup instructions for clarity

* docs: update section title for API key setup clarity

* docs: add comprehensive guide for OpenAI image generation and editing tools

* docs: clarify Stable Diffusion section and update link in Image Generation overview

* docs: add Flux cloud generator configuration details and environment variables

* fix: Firebase CDN configuration link

* docs: enhance fileStrategy section with CDN options and notes

* docs: enhance Image Generation section with improved structure and pricing details

* docs: add Code Interpreter section with environment variable details and enterprise plan notes

* fix: formatting

* chore: bump next

* fix: correct markdown formatting for artifact example in agents documentation

* docs: add deprecation notices for tools, plugins, presets, and enhance image generation section

* feat: implement GitHub stats API and update Usage component to fetch stars dynamically

* fix: update Docker pulls value in Usage component

* 🫙 fix: Azure Blob Storage Documentation (#289)

* fix: Update fileStrategy option to use "azure_blob" in configuration docs

* fix: Update CDN documentation for Azure Blob Storage and improve navigation

* fix: Remove Hetzner reference from deployment comparison, closes #271

* fix: Update RAG API documentation for clarity on feature availability, closes #249

* feat: Update demo images (#290)

* docs: Clarify configuration file usage and API key settings in documentation, closes #238

* fix: Add instructions to remove existing Docker images for local and remote setups

* 🌊 docs: Flux (#203)

* feat: Enhance documentation for Flux and related tools, including setup instructions and parameters

* docs: Update image generation documentation with additional notes on output handling and MCP server format

* feat: Add blog post on optimizing RAG performance in LibreChat with accompanying image

* chore: Remove unused image for RAG performance blog post

---------

Co-authored-by: Henk van Ess <31323314+voelspriet@users.noreply.github.com>
Co-authored-by: lensfa <80903255+lensfa-lzd@users.noreply.github.com>
Co-authored-by: Marco Beretta <81851188+berry-13@users.noreply.github.com>
Co-authored-by: heptapod <164861708+leondape@users.noreply.github.com>
2025-04-25 15:16:17 -04:00
Danny Avila
b83e42c13c feat: Enhance documentation for Flux and related tools, including setup instructions and parameters 2025-04-25 14:22:38 -04:00
heptapod
89b180f2e2 🌊 docs: Flux (#203) 2025-04-25 14:16:59 -04:00