Commit Graph

260 Commits

Author SHA1 Message Date
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
Danny Avila
d5efc8e47e fix: Add instructions to remove existing Docker images for local and remote setups 2025-04-25 14:06:13 -04:00
Danny Avila
cacf1c2fbd docs: Clarify configuration file usage and API key settings in documentation, closes #238 2025-04-25 14:03:56 -04:00
Marco Beretta
d7b0b76ba6 feat: Update demo images (#290) 2025-04-25 13:53:51 -04:00
Danny Avila
c919b8a3a8 fix: Update RAG API documentation for clarity on feature availability, closes #249 2025-04-25 13:17:48 -04:00
Danny Avila
cb59b14345 fix: Remove Hetzner reference from deployment comparison, closes #271 2025-04-25 13:13:13 -04:00
Danny Avila
0974015c57 🫙 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
2025-04-25 13:08:50 -04:00
Danny Avila
54f77a1719 🎨 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
2025-04-25 12:21:27 -04:00
lensfa
4d2deca3f5 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.
2025-04-25 07:48:17 -04:00
Marco Beretta
e4eb9fbe4a docs: custom welcome user (#275) 2025-04-04 09:47:54 +02:00
Danny Avila
f9cd648514 feat: Config v1.2.4 Changelog (#280)
* feat: Add allowedProviders and addedEndpoints features for enhanced agent configuration

* wip: changelog 1.2.4

* feat: Enhance token balance management with auto-refill settings and detailed configuration options

* feat: Enhance balance management with new configuration options for auto-refill and user balances

* docs: Mark endpointsMenu setting as deprecated and provide migration guidance
2025-04-01 22:26:32 -04:00
Ruben Talstra
488722d632 I18n/added persian (#279)
* feat: Add Hungarian Language Support in Translations

* feat: Add Persian Language Support in Translations

* feat: Remove Hungarian language support from translations
2025-04-01 22:19:21 -04:00
Ruben Talstra
2c33080312 feat: Add Hungarian Language Support in Translations (#274) 2025-03-26 13:25:20 -04:00
Danny Avila
a8390fe01f feat: Update model specs documentation to include default values for icon visibility 2025-03-25 23:13:44 -04:00
Danny Avila
785a88aa78 chore: Correct formatting and indentation in agents documentation for clarity 2025-03-25 23:13:37 -04:00
Danny Avila
6363c4dd97 feat: Add shorthand for prompt parameter and introduce spec for model selection in URL query documentation 2025-03-25 23:13:29 -04:00
Mike Averto
652b08b364 feat: Update URL Param section to include automatic submit example (#269) 2025-03-21 17:39:51 -04:00
Ruben Talstra
c8cbd30437 feat: Add balance management configuration to YAML and update token usage documentation (#272)
* feat: Add balance management configuration to YAML and update token usage documentation

* feat: Update balance management section in documentation with new YAML configuration options

* feat: Update balance configuration in interface.mdx to include auto-refill options

* feat: Add balance management documentation and configuration options
2025-03-21 17:32:43 -04:00
Danny Avila
4376a217d0 feat: Update S3 documentation to include DeleteObject permission 2025-03-21 14:18:20 -04:00
Ruben Talstra
4bf1f8fb4b feat: Add support for LDAP StartTLS and update documentation for LDAP settings (#270) 2025-03-21 07:54:31 -04:00
Ruben Talstra
07d1d9af47 feat: Add Azure Blob Storage and Amazon S3 CDN setup documentation and update metadata (#256)
* feat: Add Azure Blob Storage CDN setup documentation and update metadata

* feat: Add Amazon S3 CDN setup documentation and update existing CDN options

* feat: Enhance Amazon S3 CDN setup documentation with IRSA support for Kubernetes

* feat: Update Azure Blob Storage setup documentation to include Managed Identity authentication options
2025-03-19 10:46:30 -04:00
heptapod
bf246a058e docs: Adding documentation for OIDC Auto-Redirect #5683 (#250) 2025-03-19 09:53:03 -04:00
Danny Avila
01f5642e98 fix: Replace Next.js Image component with standard img tag in agents documentation 2025-03-19 02:11:59 -04:00
Danny Avila
75757db822 feat: Add HTTPS headers for librechat.ai domains (#266) 2025-03-19 02:09:19 -04:00
Danny Avila
6e07c668e4 ⏱ feat: Add Timeout Options and Update Agent Chain Image (#265)
* fix: Update Agent Chain Image to External Source and Remove Local File

* 📝 feat: Add timeout and initTimeout configuration options for MCP server requests

* WIP: Add `timeout` and `initTimeout` options for MCP server configuration
2025-03-19 02:00:31 -04:00
BF4C5B1330
34bef24e0b Clarify visibility of "new" models. (#261)
I struggled a long time with this, thinking something was wrong with my install.
I think this would be helpful to have mentioned here.

Source: https://github.com/danny-avila/LibreChat/discussions/1682#discussioncomment-8310689
2025-03-19 01:56:14 -04:00
Hasan Khan
72bfc9608b Update perplexity.mdx (#263)
Updated models that work in March 2025
2025-03-19 01:55:58 -04:00
Danny Avila
df2fa1bd4b 📝 feat: Agents maxRecursionLimit, Config Version Update, Agent Chain And Missing Artifacts Info (#264)
* 📝 feat: Update agent capabilities to include 'artifacts' and 'chain'

* 📝 feat: Add Agent Chain capability and Advanced Settings documentation

* 📝 feat: Add maxRecursionLimit option to agents configuration and update documentation

* 📝 feat: Update agents configuration with maxRecursionLimit and enhance capabilities documentation

* feat: Update Agent Chain documentation to include beta status and maximum agent limit
2025-03-17 16:37:18 -04:00
Danny Avila
214d8bb281 📝 feat: File Context (OCR) or Upload Files as Text (#262)
* 🌍 docs: Add OCR configuration documentation and object structure

* 🌍 docs: Enhance OCR capabilities documentation and add new feature details

* 🌍 docs: Add OCR configuration details and update links in documentation

* 🌍 docs: Update OCR configuration details and enhance documentation for new features

* 🌍 docs: Add OCR capability details and update changelog for new text extraction features

* 🌍 docs: Clarify OCR processing details in agent context and update documentation for text extraction

* 🌍 docs: Update OCR documentation title and enhance configuration details for Mistral model

* fix: example OCR `mistralModel` and clarifying comment on configuration
2025-03-10 17:23:59 -04:00
Ruben Talstra
0955c987e9 🌍 i18n: Add Thai Language Support in Translations (#259)
* 🌍 i18n: Add Thai Language Support in Translations

* fix: Update Locize Logo image source in documentation
2025-03-07 11:58:07 -05:00
Danny Avila
3f404d926b v0.7.7 (#258)
* fix: release note hyperlinks

* fix: update ogImage for v0.7.7 release and add new image file
2025-03-07 11:04:03 -05:00