🐋 docs: update breaking_changes.md (#1864)

add note about the use of the pre-built image in docker-compose.yml
This commit is contained in:
Fuegovic
2024-02-23 11:51:17 -05:00
committed by GitHub
parent 6a25dd38a4
commit 5445d55af2

View File

@@ -9,6 +9,31 @@ weight: -10
**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.
---
## 🐋 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.
Here's an example of the `docker-compose.override.yml`:
```yaml
version: '3.4'
services:
api:
image: librechat
build:
context: .
target: node
```
For more detailed information on using the `docker-compose.override.yaml`, please refer to our documentation: [docker_override](https://docs.librechat.ai/install/configuration/docker_override.html)
---
## **.env** changes v0.6.6 -> v0.6.9
see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more info
@@ -59,6 +84,7 @@ see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more
# DALLE2_AZURE_API_VERSION=
```
---
## January 31th 2024
- A new method to use the ChatGPT endpoint is now documented. It uses "Ninja"
@@ -66,22 +92,30 @@ see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more
- [Ninja Deployment Guide](../features/ninja.md)
- [Ninja GitHub repo](https://github.com/gngpp/ninja/tree/main)
---
## January 30th 2024
- Since PandoraNext has shut down, the ChatGPTbrowser endpoint is no longer available in LibreChat.
- For more info:
- [https://github.com/danny-avila/LibreChat/discussions/1663](https://github.com/danny-avila/LibreChat/discussions/1663#discussioncomment-8314025)
- [https://linux.do/t/topic/1051](https://linux.do/t/topic/1051)
---
## 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`
- 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.
---
## v0.6.x
- **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`.
---
## v0.5.9
- 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)
@@ -91,11 +125,15 @@ see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more
- *See **[.env.example](https://github.com/danny-avila/LibreChat/blob/1378eb5097b666a4add27923e47be73919957e5b/.env.example#L314)** for exact values in millisecond calculation*
---
## v0.5.8
- 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.
---
## v0.5.7
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.
@@ -107,6 +145,7 @@ for a docker install:
for a local install:
- `npm run update:local`
---
## v0.5.5
Some users have reported an error after updating their docker containers.
@@ -122,6 +161,8 @@ Some users have reported an error after updating their docker containers.
- `docker compose build`
- `docker compose up -d`
---
## v0.5.4
Some changes were made in the .env file
**Look at the .env.example for reference.**
@@ -160,12 +201,16 @@ ANTHROPIC_MODELS=claude-1,claude-instant-1,claude-2
- Choose from ANTHROPIC_MODELS which models you want to enable 🤖
---
## v0.5.3
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)
---
## v0.5.0
**Note: These changes only apply to users who are updating from a previous version of the app.**