mirror of
https://github.com/LibreChat-AI/librechat.ai.git
synced 2026-03-27 10:48:32 +07:00
07d1d9af47
* 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
182 lines
5.8 KiB
Plaintext
182 lines
5.8 KiB
Plaintext
---
|
|
title: Firebase CDN
|
|
description: This document provides instructions for setting up Firebase CDN for LibreChat
|
|
---
|
|
|
|
# Firebase CDN Setup
|
|
|
|
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.0.8
|
|
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>
|