Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-09-22 06:00:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

🔎 chore: bump meilisearch v1.7 / v0.38.0 (#2175)

Browse source 
* 🔎 chore: bump meilisearch v1.7 / v0.38.0

* ✏️ breaking_changes.md
This commit is contained in:
Fuegovic 2024-03-27 10:08:20 -04:00 • committed by GitHub
parent d4b0af3dba
commit b5d25f5e4f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 223 additions and 174 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api/package.json
View file

@ -59,7 +59,7 @@
"langchain": "^0.0.214", "langchain": "^0.0.214",
"librechat-data-provider": "*", "librechat-data-provider": "*",
"lodash": "^4.17.21", "lodash": "^4.17.21",
"meilisearch": "^0.37.0", "meilisearch": "^0.38.0",
"mime": "^3.0.0", "mime": "^3.0.0",
"module-alias": "^2.2.3", "module-alias": "^2.2.3",
"mongoose": "^7.1.1", "mongoose": "^7.1.1",

4
deploy-compose.yml
View file

@ -51,7 +51,7 @@ services:
command: mongod --noauth command: mongod --noauth
meilisearch: meilisearch:
container_name: chat-meilisearch container_name: chat-meilisearch
image: getmeili/meilisearch:v1.0 image: getmeili/meilisearch:v1.7.3
# ports: # Uncomment this to access meilisearch from outside docker # ports: # Uncomment this to access meilisearch from outside docker
# - 7700:7700 # if exposing these ports, make sure your master key is not the default value # - 7700:7700 # if exposing these ports, make sure your master key is not the default value
env_file: env_file:
@ -60,4 +60,4 @@ services:
- MEILI_HOST=http://meilisearch:7700 - MEILI_HOST=http://meilisearch:7700
- MEILI_NO_ANALYTICS=true - MEILI_NO_ANALYTICS=true
volumes: volumes:
- ./meili_data:/meili_data - ./meili_data_v1.7:/meili_data

4
docker-compose.yml
View file

@ -34,11 +34,11 @@ services:
command: mongod --noauth command: mongod --noauth
meilisearch: meilisearch:
container_name: chat-meilisearch container_name: chat-meilisearch
image: getmeili/meilisearch:v1.6 image: getmeili/meilisearch:v1.7.3
restart: always restart: always
user: "${UID}:${GID}" user: "${UID}:${GID}"
environment: environment:
- MEILI_HOST=http://meilisearch:7700 - MEILI_HOST=http://meilisearch:7700
- MEILI_NO_ANALYTICS=true - MEILI_NO_ANALYTICS=true
volumes: volumes:
- ./meili_data_v1.6:/meili_data - ./meili_data_v1.7:/meili_data

111
docs/general_info/breaking_changes.md
View file

@ -5,27 +5,30 @@ weight: -10
--- ---
# ⚠️ Breaking Changes # ⚠️ Breaking Changes
> **Note:** !!! warning
**If you experience any issues after updating, we recommend clearing your browser cache and cookies.** **If you experience any issues after updating, we recommend clearing your browser cache and cookies.**
Certain changes in the updates may impact cookies, leading to unexpected behaviors if not cleared properly. Certain changes in the updates may impact cookies, leading to unexpected behaviors if not cleared properly.
--- ---
## 🔎Meilisearch v1.6 ## v0.6.10+ (-dev build)
!!! info "🔎Meilisearch v1.7"
- **Meilisearch Update**: Following the recent update to Meilisearch, an unused folder named `meili_data_v1.6` may be present in your root directory. This folder is no longer required and **can be safely deleted** to free up space.
- **New Indexing Data Location**: With the current Meilisearch version `1.7.3`, the new indexing data location folder will be `meili_data_v1.7`.
!!! info "🔎Meilisearch v1.6"
- **Meilisearch Update**: Following the recent update to Meilisearch, an unused folder named `meili_data_v1.5` may be present in your root directory. This folder is no longer required and **can be safely deleted** to free up space. - **Meilisearch Update**: Following the recent update to Meilisearch, an unused folder named `meili_data_v1.5` may be present in your root directory. This folder is no longer required and **can be safely deleted** to free up space.
- **New Indexing Data Location**: With the current Meilisearch version `1.6`, the new indexing data location folder will be `meili_data_v1.6`. - **New Indexing Data Location**: With the current Meilisearch version `1.6`, the new indexing data location folder will be `meili_data_v1.6`.
--- !!! failure "🥷🪦 Ninja"
## 🥷🪦 Ninja - March 4, 2024 - Following to the shut down of "Ninja", the ChatGPTbrowser endpoint is no longer available in LibreChat.
- Since Ninja has shut down, the ChatGPTbrowser endpoint is no longer available in LibreChat.
--- !!! warning "🐋 `docker-compose.yml` Update"
## 🐋 docker-compose.yml - February 22nd, 2024
### Update to `docker-compose.yml`
We have made changes to the `docker-compose.yml` file to enhance the default behavior. Starting now, the file uses the pre-built image by default. If you prefer to build the image yourself, you'll need to utilize the override file to specify your custom build configuration. We have made changes to the `docker-compose.yml` file to enhance the default behavior. Starting now, the file uses the pre-built image by default. If you prefer to build the image yourself, you'll need to utilize the override file to specify your custom build configuration.
@ -46,37 +49,68 @@ For more detailed information on using the `docker-compose.override.yaml`, pleas
--- ---
## **.env** changes v0.6.6 -> v0.6.9 ## v0.6.10
!!! danger "Söhne Font Licensing Issue"
During a recent license review, it was discovered that the Söhne fonts used in LibreChat require proper licensing for legal use. These fonts were added early in the project by a community contribution to mirror ChatGPT's aesthetic, but it was an oversight to allow them without proper knowledge.
To address this issue, the Söhne fonts have been removed from the project and replaced with open-source alternatives, effective immediately in the latest version of the repository on GitHub. The relevant font foundry has been contacted to resolve the matter.
All users and those who have forked LibreChat are required to update to the latest version to comply with font licensing laws. If you prefer to continue using the fonts, please follow the instructions provided [here](https://gist.github.com/danny-avila/e1d623e51b24cf0989865197bb788102).
LibreChat remains committed to ensuring compliance, accessibility, and continuous improvement. The effort to match OpenAI's ChatGPT styling was well-intentioned but poorly executed, and moving forward, all aspects of the project will meet legal and permissive standards.
We appreciate your understanding and cooperation in making these necessary adjustments. For updates or guidance on implementing these changes, please reach out.
Thank you for your continued support of LibreChat.
---
## v0.6.9
!!! info "⚙️ Environment Variables - v0.6.6 -> v0.6.9"
see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more info see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more info
- Assistants added to the list !!! abstract "Endpoints"
```sh ```sh
# ENDPOINTS=openAI,assistants,azureOpenAI,bingAI,chatGPTBrowser,google,gptPlugins,anthropic # ENDPOINTS=openAI,assistants,azureOpenAI,bingAI,chatGPTBrowser,google,gptPlugins,anthropic
``` ```
- Updated OpenAI models
!!! abstract "OpenAI models"
```sh ```sh
# OPENAI_MODELS=gpt-3.5-turbo-0125,gpt-3.5-turbo-0301,gpt-3.5-turbo,gpt-4,gpt-4-0613,gpt-4-vision-preview,gpt-3.5-turbo-0613,gpt-3.5-turbo-16k-0613,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview,gpt-3.5-turbo-1106,gpt-3.5-turbo-instruct,gpt-3.5-turbo-instruct-0914,gpt-3.5-turbo-16k # OPENAI_MODELS=gpt-3.5-turbo-0125,gpt-3.5-turbo-0301,gpt-3.5-turbo,gpt-4,gpt-4-0613,gpt-4-vision-preview,gpt-3.5-turbo-0613,gpt-3.5-turbo-16k-0613,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview,gpt-3.5-turbo-1106,gpt-3.5-turbo-instruct,gpt-3.5-turbo-instruct-0914,gpt-3.5-turbo-16k
``` ```
- Assistants configuration
!!! abstract "Assistants API"
```sh ```sh
#====================# #====================#
# Assistants API # # Assistants API #
#====================# #====================#
# ASSISTANTS_API_KEY= ASSISTANTS_API_KEY=user_provided
# ASSISTANTS_BASE_URL= # ASSISTANTS_BASE_URL=
# ASSISTANTS_MODELS=gpt-3.5-turbo-0125,gpt-3.5-turbo-16k-0613,gpt-3.5-turbo-16k,gpt-3.5-turbo,gpt-4,gpt-4-0314,gpt-4-32k-0314,gpt-4-0613,gpt-3.5-turbo-0613,gpt-3.5-turbo-1106,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview # ASSISTANTS_MODELS=gpt-3.5-turbo-0125,gpt-3.5-turbo-16k-0613,gpt-3.5-turbo-16k,gpt-3.5-turbo,gpt-4,gpt-4-0314,gpt-4-32k-0314,gpt-4-0613,gpt-3.5-turbo-0613,gpt-3.5-turbo-1106,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview
``` ```
- Updated Plugin models
!!! abstract "Plugin models"
```sh ```sh
# PLUGIN_MODELS=gpt-4,gpt-4-turbo-preview,gpt-4-0125-preview,gpt-4-1106-preview,gpt-4-0613,gpt-3.5-turbo,gpt-3.5-turbo-0125,gpt-3.5-turbo-1106,gpt-3.5-turbo-0613 # PLUGIN_MODELS=gpt-4,gpt-4-turbo-preview,gpt-4-0125-preview,gpt-4-1106-preview,gpt-4-0613,gpt-3.5-turbo,gpt-3.5-turbo-0125,gpt-3.5-turbo-1106,gpt-3.5-turbo-0613
``` ```
- Birthday hat
!!! abstract "Birthday Hat"
```sh ```sh
# SHOW_BIRTHDAY_ICON=true # SHOW_BIRTHDAY_ICON=true
``` ```
### Previous changes:
- DALL-E !!! abstract "DALL·E"
```sh ```sh
# DALL·E # DALL·E
#---------------- #----------------
@ -96,17 +130,15 @@ see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more
# DALLE2_AZURE_API_VERSION= # DALLE2_AZURE_API_VERSION=
``` ```
--- !!! success "🥷 Ninja"
## January 31th 2024
- A new method to use the ChatGPT endpoint is now documented. It uses "Ninja" - A new method to use the ChatGPT endpoint is now documented. It uses "Ninja"
- For more info: - For more info:
- ~~[Ninja Deployment Guide](../general_info/breaking_changes.md)~~ - ~~[Ninja Deployment Guide](../general_info/breaking_changes.md)~~
- [Ninja GitHub repo](https://github.com/gngpp/ninja/tree/main) - [Ninja GitHub repo](https://github.com/gngpp/ninja/tree/main)
--- !!! failure "🪦 PandoraNext"
## January 30th 2024
- Since PandoraNext has shut down, the ChatGPTbrowser endpoint is no longer available in LibreChat. - Since PandoraNext has shut down, the ChatGPTbrowser endpoint is no longer available in LibreChat.
- For more info: - For more info:
- [https://github.com/danny-avila/LibreChat/discussions/1663](https://github.com/danny-avila/LibreChat/discussions/1663#discussioncomment-8314025) - [https://github.com/danny-avila/LibreChat/discussions/1663](https://github.com/danny-avila/LibreChat/discussions/1663#discussioncomment-8314025)
@ -116,6 +148,8 @@ see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more
## v0.6.6 ## v0.6.6
!!! abstract "v0.6.6"
- **DALL-E Update**: user-provided keys for DALL-E are now specific to each DALL-E version, i.e.: `DALLE3_API_KEY` and `DALLE2_API_KEY` - **DALL-E Update**: user-provided keys for DALL-E are now specific to each DALL-E version, i.e.: `DALLE3_API_KEY` and `DALLE2_API_KEY`
- Note: `DALLE_API_KEY` will work for both DALL-E-3 and DALL-E-2 when the admin provides the credential; in other words, this may only affect your users if DALLE_API_KEY is not set in the `.env` file. In this case, they will simply have to "uninstall" the plugin, and provide their API key again. - Note: `DALLE_API_KEY` will work for both DALL-E-3 and DALL-E-2 when the admin provides the credential; in other words, this may only affect your users if DALLE_API_KEY is not set in the `.env` file. In this case, they will simply have to "uninstall" the plugin, and provide their API key again.
@ -123,6 +157,8 @@ see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more
## v0.6.x ## v0.6.x
!!! info "Meilisearch"
- **Meilisearch Update**: Following the recent update to Meilisearch, an unused folder named `meili_data` may be present in your root directory. This folder is no longer required and can be **safely deleted** to free up space. - **Meilisearch Update**: Following the recent update to Meilisearch, an unused folder named `meili_data` may be present in your root directory. This folder is no longer required and can be **safely deleted** to free up space.
- **New Indexing Data Location**: The indexing data has been relocated. It will now be stored in a new folder named `meili_data_v1.x`, where `1.x` represents the version of Meilisearch. For instance, with the current Meilisearch version `1.5`, the folder will be `meili_data_v1.5`. - **New Indexing Data Location**: The indexing data has been relocated. It will now be stored in a new folder named `meili_data_v1.x`, where `1.x` represents the version of Meilisearch. For instance, with the current Meilisearch version `1.5`, the folder will be `meili_data_v1.5`.
@ -130,6 +166,8 @@ see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more
## v0.5.9 ## v0.5.9
!!! warning "JWT Secret"
- It's now required to set a **JWT_REFRESH_SECRET** in your .env file as of [#927](https://github.com/danny-avila/LibreChat/pull/927) - It's now required to set a **JWT_REFRESH_SECRET** in your .env file as of [#927](https://github.com/danny-avila/LibreChat/pull/927)
- It's also recommended you update your `SESSION_EXPIRY` to a lower value and set `REFRESH_TOKEN_EXPIRY` - It's also recommended you update your `SESSION_EXPIRY` to a lower value and set `REFRESH_TOKEN_EXPIRY`
@ -141,6 +179,8 @@ see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more
## v0.5.8 ## v0.5.8
!!! info "manifest JSON files"
- It's now required to name manifest JSON files (for [ChatGPT Plugins](../features/plugins/chatgpt_plugins_openapi.md)) in the `api\app\clients\tools\.well-known` directory after their `name_for_model` property should you add one yourself. - It's now required to name manifest JSON files (for [ChatGPT Plugins](../features/plugins/chatgpt_plugins_openapi.md)) in the `api\app\clients\tools\.well-known` directory after their `name_for_model` property should you add one yourself.
- This was a recommended convention before, but is now required. - This was a recommended convention before, but is now required.
@ -148,6 +188,8 @@ see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more
## v0.5.7 ## v0.5.7
!!! tip "Update LibreChat"
Now, we have an easier and safer way to update LibreChat. You can simply run `npm run update` from the project directory for a clean update. Now, we have an easier and safer way to update LibreChat. You can simply run `npm run update` from the project directory for a clean update.
If you want to skip the prompt you can use If you want to skip the prompt you can use
@ -160,6 +202,9 @@ for a local install:
--- ---
## v0.5.5 ## v0.5.5
!!! warning "Possible Error and Solution"
Some users have reported an error after updating their docker containers. Some users have reported an error after updating their docker containers.
![image](https://github.com/fuegovic/LibreChat/assets/32828263/1265d664-5a9c-47d2-b405-47bc0d029a8d) ![image](https://github.com/fuegovic/LibreChat/assets/32828263/1265d664-5a9c-47d2-b405-47bc0d029a8d)
@ -176,6 +221,9 @@ Some users have reported an error after updating their docker containers.
--- ---
## v0.5.4 ## v0.5.4
!!! abstract ".env file"
Some changes were made in the .env file Some changes were made in the .env file
**Look at the .env.example for reference.** **Look at the .env.example for reference.**
@ -217,6 +265,8 @@ ANTHROPIC_MODELS=claude-1,claude-instant-1,claude-2
## v0.5.3 ## v0.5.3
!!! warning "Azure API Key variable"
Changed **AZURE_OPENAI_API_KEY** to **AZURE_API_KEY**: Changed **AZURE_OPENAI_API_KEY** to **AZURE_API_KEY**:
I had to change the environment variable from AZURE_OPENAI_API_KEY to AZURE_API_KEY, because the former would be read by langchain and cause issues when a user has both Azure and OpenAI keys set. This is a [known issue in the langchain library](https://github.com/hwchase17/langchainjs/issues/1687) I had to change the environment variable from AZURE_OPENAI_API_KEY to AZURE_API_KEY, because the former would be read by langchain and cause issues when a user has both Azure and OpenAI keys set. This is a [known issue in the langchain library](https://github.com/hwchase17/langchainjs/issues/1687)
@ -225,16 +275,16 @@ I had to change the environment variable from AZURE_OPENAI_API_KEY to AZURE_API_
## v0.5.0 ## v0.5.0
!!! warning "Summary"
**Note: These changes only apply to users who are updating from a previous version of the app.** **Note: These changes only apply to users who are updating from a previous version of the app.**
### Summary
- In this version, we have simplified the configuration process, improved the security of your credentials, and updated the docker instructions. 🚀 - In this version, we have simplified the configuration process, improved the security of your credentials, and updated the docker instructions. 🚀
- Please read the following sections carefully to learn how to upgrade your app and avoid any issues. 🙏 - Please read the following sections carefully to learn how to upgrade your app and avoid any issues. 🙏
- **Note:** If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.librechat.ai) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/new?category=troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible. - **Note:** If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.librechat.ai) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/new?category=troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
---
### Configuration !!! info "Configuration"
- We have simplified the configuration process by using a single `.env` file in the root folder instead of separate `/api/.env` and `/client/.env` files. - We have simplified the configuration process by using a single `.env` file in the root folder instead of separate `/api/.env` and `/client/.env` files.
- We have renamed the `OPENAI_KEY` variable to `OPENAI_API_KEY` to match the official documentation. The upgrade script should do this automatically for you, but please double-check that your key is correct in the new `.env` file. - We have renamed the `OPENAI_KEY` variable to `OPENAI_API_KEY` to match the official documentation. The upgrade script should do this automatically for you, but please double-check that your key is correct in the new `.env` file.
- We have removed the `VITE_SHOW_GOOGLE_LOGIN_OPTION` variable, since it is no longer needed. The app will automatically enable Google Login if you provide the `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET` variables. 🔑 - We have removed the `VITE_SHOW_GOOGLE_LOGIN_OPTION` variable, since it is no longer needed. The app will automatically enable Google Login if you provide the `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET` variables. 🔑
@ -247,19 +297,18 @@ I had to change the environment variable from AZURE_OPENAI_API_KEY to AZURE_API_
- The upgrade script will do it for you, otherwise you can use this replit to generate some crypto keys quickly: https://replit.com/@daavila/crypto#index.js - The upgrade script will do it for you, otherwise you can use this replit to generate some crypto keys quickly: https://replit.com/@daavila/crypto#index.js
- Make sure you keep your crypto keys safe and don't share them with anyone. 🙊 - Make sure you keep your crypto keys safe and don't share them with anyone. 🙊
---
### Docker !!! info "docker"
- The docker-compose file had some change. Review the [new docker instructions](../install/installation/docker_compose_install.md) to make sure you are setup properly. This is still the simplest and most effective method. - The docker-compose file had some change. Review the [new docker instructions](../install/installation/docker_compose_install.md) to make sure you are setup properly. This is still the simplest and most effective method.
--- !!! info "Local Install"
### Local Install
- If you had installed a previous version, you can run `npm run upgrade` to automatically copy the content of both files to the new `.env` file and backup the old ones in the root dir. - If you had installed a previous version, you can run `npm run upgrade` to automatically copy the content of both files to the new `.env` file and backup the old ones in the root dir.
- If you are installing the project for the first time, it's recommend you run the installation script `npm run ci` to guide your local setup (otherwise continue to use docker) - If you are installing the project for the first time, it's recommend you run the installation script `npm run ci` to guide your local setup (otherwise continue to use docker)
- The upgrade script requires both `/api/.env` and `/client/.env` files to run properly. If you get an error about a missing client env file, just rename the `/client/.env.example` file to `/client/.env` and run the script again. - The upgrade script requires both `/api/.env` and `/client/.env` files to run properly. If you get an error about a missing client env file, just rename the `/client/.env.example` file to `/client/.env` and run the script again.
- After running the upgrade script, the `OPENAI_API_KEY` variable might be placed in a different section in the new `.env` file than before. This does not affect the functionality of the app, but if you want to keep it organized, you can look for it near the bottom of the file and move it to its usual section. - After running the upgrade script, the `OPENAI_API_KEY` variable might be placed in a different section in the new `.env` file than before. This does not affect the functionality of the app, but if you want to keep it organized, you can look for it near the bottom of the file and move it to its usual section.
---
We apologize for any inconvenience caused by these changes. We hope you enjoy the new and improved version of our app! We apologize for any inconvenience caused by these changes. We hope you enjoy the new and improved version of our app!

10
package-lock.json generated
View file

@ -73,7 +73,7 @@
"langchain": "^0.0.214", "langchain": "^0.0.214",
"librechat-data-provider": "*", "librechat-data-provider": "*",
"lodash": "^4.17.21", "lodash": "^4.17.21",
"meilisearch": "^0.37.0", "meilisearch": "^0.38.0",
"mime": "^3.0.0", "mime": "^3.0.0",
"module-alias": "^2.2.3", "module-alias": "^2.2.3",
"mongoose": "^7.1.1", "mongoose": "^7.1.1",
@ -19214,9 +19214,9 @@
} }
}, },
"node_modules/meilisearch": { "node_modules/meilisearch": {
"version": "0.37.0", "version": "0.38.0",
"resolved": "https://registry.npmjs.org/meilisearch/-/meilisearch-0.37.0.tgz", "resolved": "https://registry.npmjs.org/meilisearch/-/meilisearch-0.38.0.tgz",
"integrity": "sha512-LdbK6JmRghCawrmWKJSEQF0OiE82md+YqJGE/U2JcCD8ROwlhTx0KM6NX4rQt0u0VpV0QZVG9umYiu3CSSIJAQ==", "integrity": "sha512-bHaq8nYxSKw9/Qslq1Zes5g9tHgFkxy/I9o8942wv2PqlNOT0CzptIkh/x98N52GikoSZOXSQkgt6oMjtf5uZw==",
"dependencies": { "dependencies": {
"cross-fetch": "^3.1.6" "cross-fetch": "^3.1.6"
} }
@ -27994,7 +27994,7 @@
}, },
"packages/data-provider": { "packages/data-provider": {
"name": "librechat-data-provider", "name": "librechat-data-provider",
"version": "0.4.8", "version": "0.5.1",
"license": "ISC", "license": "ISC",
"dependencies": { "dependencies": {
"@types/js-yaml": "^4.0.9", "@types/js-yaml": "^4.0.9",