mirror of
https://github.com/LibreChat-AI/librechat.ai.git
synced 2026-03-27 02:38:32 +07:00
* chore: update GitHub Actions workflow to use latest action version for improved stability * chore: update roadmap references and enhance documentation for AWS Bedrock inference profiles - Updated footer menu and card icons to reflect the 2026 roadmap. - Adjusted default values in changelog and configuration documentation for `maxRecursionLimit`. - Added comprehensive documentation for AWS Bedrock inference profiles, including setup, configuration, and examples. - Introduced Agents API documentation for programmatic access to LibreChat agents. - Enhanced existing documentation for clarity and consistency across various sections. * feat: release Config v1.3.4 with new features and updates - Introduced `create` field in `interface.prompts` and `interface.agents` for enhanced user control. - Added `interface.remoteAgents` configuration for managing remote agent permissions. - Updated `endpoints.bedrock` with `models` and `inferenceProfiles` for better customization. - Included Moonshot as a known endpoint for AI integration. - Introduced new agent capabilities: `deferred_tools` and `programmatic_tools`. - Removed deprecated `forcePrompt` setting from configurations. - Updated default model lists and added support for new models. - Enhanced `modelSpecs` with `artifacts` field and `effort` parameter for Anthropic models. * refactor: update BlogHeader to use usePathname for route handling - Replaced useRouter with usePathname for improved routing in BlogHeader component. - Simplified page retrieval logic by directly using pathname for matching routes. * feat: add changelog for v0.8.3-rc1 release with new features and fixes - Introduced several enhancements including event-driven lazy tool loading, token usage tracking, and programmatic tool calling UI. - Added support for new models and providers, including Claude Opus 4.6 and Moonshot. - Implemented various bug fixes and improvements for better user experience and performance. * chore: nextjs artifact * first draft roadmap * feat: enhance BlogPage with Open Graph image support and layout improvements - Added support for Open Graph images in blog entries to improve visual presentation. - Refactored article layout for better structure and readability, including adjustments to the display of metadata and content. - Updated styles for improved user experience during hover interactions. * feat: enhance BlogPage with date formatting and layout adjustments - Added a new dateFormatted field to entries for improved date display. - Implemented a date formatter for consistent date presentation. - Refactored article layout to use a grid system for better responsiveness. - Updated styles for article links and metadata for enhanced user experience. * feat: add responsive image sizes to BlogPage for improved layout - Included sizes attribute for Open Graph images to enhance responsiveness on different screen sizes. * feat: update feature titles and descriptions for clarity - Changed titles for "Forking Messages and Conversations" to "Forking Chats" and "Memory" to "User Memory" for better alignment with functionality. - Updated descriptions for "Message Search" and "Upload as Text" to enhance understanding of features. * chore: update configuration version to 1.3.4 across multiple documentation files - Updated the version number in `librechat.yaml` examples to reflect the latest release (1.3.4) in various configuration and feature documentation files. * feat: enhance User Memory documentation for clarity and detail - Updated the description to clarify that User Memory is a key/value store that operates on every chat request. - Added a callout to distinguish between key/value storage and conversation memory. - Expanded on the functionality of the memory agent, including its execution process and user control features. - Introduced a section on future improvements for the memory agent's efficiency and relevance. * feat: update title and description for NGINX documentation - Changed the title from "Secure Deployment with Nginx" to "NGINX" for brevity. - Updated the description to provide a clearer overview of the guide's purpose in securing LibreChat deployment with Nginx as a reverse proxy and HTTPS. * feat: update 2026 roadmap with key accomplishments and future plans - Celebrated LibreChat's 3rd anniversary with a summary of achievements from 2025, including growth in GitHub stars and community engagement. - Clarified the timeline for open-sourcing the Code Interpreter API by the end of Q1. - Revised notes on the v1 Admin Panel's core capabilities and community-driven items for better clarity and detail. * feat: enhance blog and author components with Open Graph image support - Added optional `ogImagePosition` field to blog entries for better image placement control. - Updated BlogPage and individual post pages to utilize the new `ogImagePosition` for responsive image styling. - Improved Author component to conditionally render author images based on availability. - Updated 2026 roadmap blog post with a new Open Graph image and position for enhanced visual appeal. * feat: enhance CardComponent with icon support and layout improvements - Added optional `icon` prop to CardComponent for better visual representation. - Updated CardComponent layout to include icon alongside title and children. - Improved styling for CardComponent and CardsBase for enhanced responsiveness and user experience. * feat: update 2026 roadmap with detailed focus areas and community-driven items - Added sections for Q1 and Q2 focus areas, outlining major initiatives like Dynamic Context and Admin Panel. - Enhanced clarity on community-driven items and their prioritization based on GitHub reactions. - Included hiring information to attract full-stack developers for ongoing project support. - Improved overall structure and readability of the roadmap content. * fix: improve icon styling in CardCompat component for better responsiveness - Updated icon container styling to ensure consistent height and width for SVG icons. - Enhanced layout of CardCompat to maintain visual integrity across different screen sizes. * chore: update .gitignore to include next-env.d.ts for TypeScript support * fix: correct import statement formatting in next-env.d.ts for consistency * fix: refine wording in 2026 roadmap for clarity - Updated the description of agentic workflows to emphasize a lean approach to context pulling. - Enhanced overall readability of the section on Dynamic Context. * feat: expand Admin Panel section in 2026 roadmap with detailed capabilities - Added comprehensive descriptions of the Admin Panel's core functionalities, including GUI for configuration, configuration profiles, group and role management, and access controls. - Clarified the development approach for the Admin Panel, emphasizing ongoing iteration and community involvement. - Updated note on the Admin Panel's prioritization and requirements following the ClickHouse acquisition. * feat: add TrackedLink component for enhanced analytics tracking - Introduced a new TrackedLink component that integrates Vercel analytics to track user interactions with links. - The component allows for customizable link properties while ensuring tracking of clicks with relevant metadata. - Updated CardCompat to utilize the new TrackedLink for improved user engagement tracking. * feat: enhance blog post layout and introduce TrackedAnchor component for link tracking - Wrapped the InlineTOC component in a div for improved spacing in blog posts. - Added a new TrackedAnchor component to facilitate link tracking with Vercel analytics, allowing for customizable anchor elements. - Updated mdx-components to utilize TrackedAnchor for enhanced link interaction tracking. * feat: update TrackedLink and TrackedAnchor components for external link handling - Enhanced the TrackedLink component to differentiate between internal and external links, using Next.js Link for internal navigation. - Introduced a utility function to determine if a link is external, improving tracking accuracy. - Updated TrackedAnchor to utilize the same external link handling logic for consistency in link tracking. * feat: add uncaught exception handling section to dotenv configuration documentation - Introduced a new section on uncaught exception handling, explaining how to override the default behavior to keep the app running after exceptions. - Added an option table detailing the `CONTINUE_ON_UNCAUGHT_EXCEPTION` configuration. - Included a warning callout advising against using this feature in production environments. * feat: add ESLint rule for unused variables in TypeScript - Introduced a new ESLint rule to enforce the handling of unused variables, allowing for specific patterns to be ignored. - This enhancement aims to improve code quality by ensuring that developers are alerted to potentially unnecessary variables while maintaining flexibility in naming conventions. * fix: update copyright year in LICENSE file to 2026 * feat: update footer menu link and add 2026 roadmap blog post - Changed the roadmap link in the FooterMenu component to point to the new blog post. - Introduced a new blog post detailing the 2026 roadmap for LibreChat, outlining key features and focus areas for the upcoming year. - Updated the import statement in next-env.d.ts for consistency with the new types directory. * fix: update import path in next-env.d.ts and add comment block in agents.mdx - Changed the import statement in next-env.d.ts to reference the new development types directory. - Added a comment block in agents.mdx to indicate that the Programmatic Tool Calling feature is in private beta. * fix: remove unused ESLint disable comment in context.tsx * chore: update blog
169 lines
7.4 KiB
Plaintext
169 lines
7.4 KiB
Plaintext
---
|
||
title: Azure Blob Storage CDN
|
||
icon: Cloud
|
||
description: This document provides instructions for setting up Azure Blob Storage CDN for LibreChat
|
||
---
|
||
|
||
{/* Adding a table of contents for better navigation */}
|
||
<div className="mt-8 mb-16">
|
||
<h2 className="text-lg font-semibold mb-4">On this page</h2>
|
||
<ul className="space-y-2">
|
||
<li><a href="#production-setup">Production Setup</a></li>
|
||
<li><a href="#local-development-with-azurite">Local Development with Azurite</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
## Production Setup
|
||
|
||
Azure Blob Storage offers scalable, secure object storage that can be used as a CDN for your static assets such as images, CSS, and JavaScript. Follow these steps to configure your Azure Blob Storage for LibreChat.
|
||
|
||
## 1. Create an Azure Storage Account
|
||
|
||
1. **Sign in to Azure:**
|
||
- Open the [Azure Portal](https://portal.azure.com/) and sign in with your Microsoft account.
|
||
|
||
2. **Create a Storage Account:**
|
||
- Click on **"Create a resource"** and search for **"Storage account"**.
|
||
- Click **"Create"** and fill in the required details:
|
||
- **Subscription & Resource Group:** Choose your subscription and either select an existing resource group or create a new one.
|
||
- **Storage Account Name:** Enter a unique name (e.g., `mylibrechatstorage`).
|
||
- **Region:** Select the region closest to your users.
|
||
- **Performance & Redundancy:** Choose the performance tier and redundancy level that best suit your needs.
|
||
- Click **"Review + Create"** and then **"Create"**. Wait until the deployment completes.
|
||
|
||
## 2. Set Up Authentication
|
||
|
||
You have two options for authenticating with your Azure Storage Account:
|
||
|
||
### Option A: Using a Connection String
|
||
|
||
1. **Navigate to Access Keys:**
|
||
- In your newly created storage account, go to **"Access keys"** in the sidebar.
|
||
|
||
2. **Copy Connection String:**
|
||
- Copy one of the connection strings provided. This string includes the credentials required to connect to your Blob Storage account.
|
||
|
||
### Option B: Using Managed Identity
|
||
|
||
If your LibreChat application is running on an Azure service that supports Managed Identity (such as an Azure VM, App Service, or AKS), you can use that instead of a connection string.
|
||
|
||
1. **Assign Managed Identity:**
|
||
- Ensure your Azure resource (VM, App Service, or AKS) has a system-assigned or user-assigned Managed Identity enabled.
|
||
|
||
2. **Grant Storage Permissions:**
|
||
- In your storage account, assign the **Storage Blob Data Contributor** (or a similarly scoped role) to your Managed Identity. This allows your application to access Blob Storage without a connection string.
|
||
|
||
## 3. Update Your Environment Variables
|
||
|
||
Create or update your `.env` file in your project’s root with the following configuration:
|
||
|
||
```bash filename=".env"
|
||
# Option A: Using a Connection String
|
||
AZURE_STORAGE_CONNECTION_STRING=DefaultEndpointsProtocol=https;AccountName=yourAccountName;AccountKey=yourAccountKey;EndpointSuffix=core.windows.net
|
||
|
||
# Option B: Using Managed Identity (do not set the connection string if using Managed Identity)
|
||
AZURE_STORAGE_ACCOUNT_NAME=yourAccountName
|
||
|
||
AZURE_STORAGE_PUBLIC_ACCESS=false
|
||
AZURE_CONTAINER_NAME=files
|
||
```
|
||
|
||
- **AZURE_STORAGE_CONNECTION_STRING:** Set this if you are using Option A.
|
||
- **AZURE_STORAGE_ACCOUNT_NAME:** Set this if you are using Option B (Managed Identity). Do not set both.
|
||
- **AZURE_STORAGE_PUBLIC_ACCESS:** Set to `false` if you do not want your blobs to be publicly accessible by default. Set to `true` if you need public access (for example, for publicly viewable images).
|
||
- **AZURE_CONTAINER_NAME:** This is the container name your application will use (e.g., `files`). The application will automatically create this container if it doesn’t exist.
|
||
|
||
## 4. Configure LibreChat to Use Azure Blob Storage
|
||
|
||
Update your LibreChat configuration file (`librechat.yaml`) to specify that the application should use Azure Blob Storage for file handling:
|
||
|
||
```yaml filename="librechat.yaml"
|
||
version: 1.3.4
|
||
cache: true
|
||
fileStrategy: "azure_blob"
|
||
```
|
||
|
||
This setting tells LibreChat to use the Azure Blob Storage implementation provided in your code.
|
||
|
||
---
|
||
|
||
## Summary
|
||
|
||
1. **Create a Storage Account:**
|
||
Sign in to the Azure Portal, create a storage account, and wait for deployment to finish.
|
||
|
||
2. **Set Up Authentication:**
|
||
- **Option A:** Retrieve the connection string from **"Access keys"** in your storage account.
|
||
- **Option B:** Use Managed Identity by enabling it on your Azure resource and granting it appropriate storage permissions.
|
||
|
||
3. **Update Environment Variables:**
|
||
In your `.env` file, set either:
|
||
- `AZURE_STORAGE_CONNECTION_STRING` (for Option A), or
|
||
- `AZURE_STORAGE_ACCOUNT_NAME` (for Option B), along with:
|
||
- `AZURE_STORAGE_PUBLIC_ACCESS` and
|
||
- `AZURE_CONTAINER_NAME`.
|
||
|
||
4. **Configure LibreChat:**
|
||
Set `fileStrategy` to `"azure_blob"` in your `librechat.yaml` configuration file.
|
||
|
||
With these steps, your LibreChat application will automatically create the container (if it doesn't exist) and manage file uploads, downloads, and deletions using Azure Blob Storage as your CDN. Managed Identity provides a secure alternative by eliminating the need for long-term credentials.
|
||
|
||
## Local Development with Azurite
|
||
|
||
For local development and testing, you can use [Azurite](https://github.com/Azure/Azurite), an Azure Storage emulator that provides a local environment for testing your Azure Blob Storage integration without needing an actual Azure account.
|
||
|
||
### 1. Set Up Azurite
|
||
|
||
You can run Azurite in several ways:
|
||
|
||
#### Option A: Using VS Code Extension (Recommended for Development)
|
||
|
||
1. Install the [Azurite extension](https://marketplace.visualstudio.com/items?itemName=Azurite.azurite) for VS Code
|
||
2. Open the command palette (Ctrl+Shift+P or Cmd+Shift+P)
|
||
3. Search for and select "Azurite: Start"
|
||
|
||
This will start Azurite in the background with default settings.
|
||
|
||
#### Option B: Using Docker
|
||
|
||
```bash
|
||
docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 mcr.microsoft.com/azure-storage/azurite
|
||
```
|
||
|
||
#### Option C: Using npm
|
||
|
||
```bash
|
||
npm install -g azurite
|
||
azurite --silent --location /path/to/azurite/workspace --debug /path/to/debug/log
|
||
```
|
||
|
||
### 2. Configure Environment Variables for Local Development
|
||
|
||
Add the following environment variables to your `.env` file:
|
||
|
||
```bash filename=".env"
|
||
# Azurite connection string for local development
|
||
AZURE_STORAGE_CONNECTION_STRING="DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;"
|
||
AZURE_STORAGE_PUBLIC_ACCESS=true
|
||
AZURE_CONTAINER_NAME=files
|
||
```
|
||
|
||
Notes:
|
||
- The `AccountKey` value is the default development key used by Azurite
|
||
- The connection uses `http` protocol instead of `https` for local development
|
||
- The `BlobEndpoint` points to the local Azurite instance running on port 10000
|
||
|
||
### 3. Verify the Connection
|
||
|
||
To verify that your application can connect to the local Azurite instance:
|
||
|
||
1. Start your LibreChat application
|
||
2. Attempt to upload a file through the interface
|
||
3. Check the Azurite logs to confirm the connection and operations
|
||
|
||
If you're using the VS Code extension, you can view the Azurite logs in the Output panel by selecting "Azurite Blob" from the dropdown.
|
||
|
||
<Callout type="info" title="Note">
|
||
The default Azurite account key is a fixed value used for development purposes only. Never use this key in production environments. Always ensure that your connection string remains secure and never commit it to a public repository.
|
||
</Callout>
|