mirror of
https://github.com/LibreChat-AI/librechat.ai.git
synced 2026-03-27 02:38:32 +07:00
9e1a0db393
* 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
181 lines
5.8 KiB
Plaintext
181 lines
5.8 KiB
Plaintext
---
|
|
title: Firebase CDN
|
|
icon: Flame
|
|
description: This document provides instructions for setting up Firebase CDN for LibreChat
|
|
---
|
|
|
|
Firebase CDN (Content Delivery Network) is a feature of the Firebase platform that allows you to host and serve static assets, such as HTML, CSS, JavaScript, images, and videos, from a network of edge locations around the world.
|
|
|
|
## Steps to Set Up Firebase
|
|
|
|
1. Open the [Firebase website](https://firebase.google.com/).
|
|
2. Click on "Get started."
|
|
3. Sign in with your Google account.
|
|
|
|
### Create a New Project
|
|
|
|
- Name your project (you can use the same project as Google OAuth).
|
|
|
|
|
|
|
|
- Optionally, you can disable Google Analytics.
|
|
|
|
|
|
|
|
- Wait for 20/30 seconds for the project to be ready, then click on "Continue."
|
|
|
|
|
|
|
|
- Click on "All Products."
|
|
|
|
|
|
|
|
- Select "Storage."
|
|
|
|
|
|
|
|
- Click on "Get Started."
|
|
|
|
|
|
|
|
- Click on "Next."
|
|
|
|
|
|
|
|
- Select your "Cloud Storage location."
|
|
|
|
|
|
|
|
- Return to the Project Overview.
|
|
|
|
|
|
|
|
- Click on "+ Add app" under your project name, then click on "Web."
|
|
|
|
|
|
|
|
- Register the app.
|
|
|
|
|
|
|
|
- Save all this information in a text file.
|
|
|
|
|
|
|
|
- Fill all the `firebaseConfig` variables in the `.env` file.
|
|
|
|
```bash
|
|
FIREBASE_API_KEY=api_key #apiKey
|
|
FIREBASE_AUTH_DOMAIN=auth_domain #authDomain
|
|
FIREBASE_PROJECT_ID=project_id #projectId
|
|
FIREBASE_STORAGE_BUCKET=storage_bucket #storageBucket
|
|
FIREBASE_MESSAGING_SENDER_ID=messaging_sender_id #messagingSenderId
|
|
FIREBASE_APP_ID=1:your_app_id #appId
|
|
```
|
|
|
|
- Return one last time to the Project Overview.
|
|
|
|
|
|
|
|
- Select `Storage`
|
|
|
|
|
|
|
|
- Select `Rules` and delete `: if false;` on this line: `allow read, write: if false;`
|
|
|
|
- your updated rules should look like this:
|
|
|
|
```bash
|
|
rules_version = '2';
|
|
|
|
service firebase.storage {
|
|
match /b/{bucket}/o {
|
|
match /images/{userId}/{fileName} {
|
|
allow read, write: if true;
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
|
|
|
|
- Publish your updated rules
|
|
|
|
|
|
|
|
### Configure `fileStrategy` in `librechat.yaml`
|
|
|
|
Finally, to enable the app use Firebase, you must set the following in your `librechat.yaml` config file.
|
|
|
|
```yaml
|
|
version: 1.3.4
|
|
cache: true
|
|
fileStrategy: "firebase"
|
|
```
|
|
|
|
For more information about the `librechat.yaml` config file, see the guide here: [Custom Endpoints & Configuration](/docs/configuration/librechat_yaml).
|
|
|
|
<Callout type="warning" title="Export convos as png when using Firebase">
|
|
|
|
### Step-by-Step Guide to Set Up CORS for Firebase Storage
|
|
|
|
---
|
|
|
|
#### **Step 1: Create the CORS Configuration File**
|
|
|
|
- Open a text editor of your choice.
|
|
- Create a new file and name it `cors.json`.
|
|
- Add the following configuration to allow access from "https://ai.example.com":
|
|
|
|
```json
|
|
[
|
|
{
|
|
"origin": ["https://ai.example.com"],
|
|
"method": ["GET", "POST", "DELETE", "PUT"],
|
|
"maxAgeSeconds": 3600
|
|
}
|
|
]
|
|
```
|
|
- Save the file.
|
|
|
|
---
|
|
|
|
#### **Step 2: Apply the CORS Configuration**
|
|
|
|
- Open your terminal or command prompt.
|
|
- Navigate to the directory where you saved the `cors.json` file.
|
|
- Execute the following command, replacing `<your-cloud-storage-bucket>` with the name of your Firebase Storage bucket:
|
|
|
|
```shell
|
|
gsutil cors set cors.json gs://<your-cloud-storage-bucket>
|
|
```
|
|
|
|
---
|
|
|
|
#### **Step 3: Verify the CORS Settings**
|
|
|
|
- To confirm that the CORS settings have been applied correctly, you can retrieve the current CORS configuration with the following command:
|
|
|
|
```shell
|
|
gsutil cors get gs://<your-cloud-storage-bucket>
|
|
```
|
|
|
|
- The output should reflect the settings you specified in the `cors.json` file.
|
|
|
|
---
|
|
|
|
#### **Step 4: Test the Configuration**
|
|
|
|
- Try exporting a convo as png from the allowed origin ("https://ai.example.com").
|
|
- If everything is set up correctly, you should not encounter any CORS issues.
|
|
|
|
---
|
|
|
|
> **Note:** Always ensure that you're applying CORS settings only for trusted origins to maintain the security of your application. Adjust the allowed methods and headers according to your specific needs.
|
|
|
|
---
|
|
|
|
That's it! You've successfully configured CORS for your Firebase Storage bucket to allow requests from a specific origin. Remember to replace `<your-cloud-storage-bucket>` with your actual bucket name and `https://ai.example.com` with your own domain when applying the configuration.
|
|
|
|
</Callout>
|