Skip to content

docs: Document AWS_ENDPOINT_URL for S3 configuration #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2025

Conversation

lensfa-lzd
Copy link
Contributor

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 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.

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](danny-avila/LibreChat#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.
Copy link

vercel bot commented Apr 17, 2025

@lensfa-lzd is attempting to deploy a commit to the LibreChat's projects Team on Vercel.

A member of the Team first needs to authorize it.

@danny-avila danny-avila merged commit 4d2deca into LibreChat-AI:main Apr 25, 2025
0 of 2 checks passed
danny-avila pushed a commit that referenced this pull request Apr 25, 2025
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](danny-avila/LibreChat#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.
danny-avila added a commit that referenced this pull request Apr 25, 2025
* 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](danny-avila/LibreChat#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 <[email protected]>
Co-authored-by: lensfa <[email protected]>
Co-authored-by: Marco Beretta <[email protected]>
Co-authored-by: heptapod <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants