📝 docs: add env changes to breaking_changes.md and minor fixes (#1812)

* 📝 docs: add env changes to breacking_changes.md

* 📝 docs: replace example in docker_override.md

* 📝 docs: fix images in zeabur.md

.env.example

@@ -323,14 +323,9 @@ FIREBASE_APP_ID=
 
 # NODE_ENV=
 
-# If using Redis, you should flush the cache after changing any LibreChat settings
 # REDIS_URI=
 # USE_REDIS=
 
-# Give the AI Icon a Birthday Hat :) 
-# Will show automatically on February 11th (LibreChat's birthday)
-# Set this to false to disable the birthday hat
-# Set to true to enable all the time.
 # SHOW_BIRTHDAY_ICON=true
 
 # E2E_USER_EMAIL=

docs/deployment/zeabur.md

@@ -12,7 +12,7 @@ This guide will walk you through deploying LibreChat on Zeabur.
 If you don't have a Zeabur account, you need to sign up for one.
 Visit [here](https://zeabur.com/login) and click on `Login with GitHub` to create an account and sign in.
 
-![Sign up for a Zeabur account](https://i.imgur.com/aUuOcWg.png)
+![Sign up for a Zeabur account](https://github.com/danny-avila/LibreChat/assets/32828263/3e2d680d-c52a-46fb-a194-22306383c2d4)
 
 ## Deploy with button
 
@@ -22,22 +22,22 @@ Zeabur has already prepared a one-click deployment template for LibreChat, so yo
 
 In the template page, select the region where you want to deploy LibreChat, and then click the Deploy button to start the deployment.
 
-![Select Region and Deploy](https://i.imgur.com/cpfrA0k.png)
+![Select Region and Deploy](https://github.com/danny-avila/LibreChat/assets/32828263/3676170b-9d59-46bf-81ca-48a5c7f1d657)
 
 ## Bind a domain 
 
 After the deployment is complete, you will find that there is a new project in your Zeabur account, which contains three services: a MongoDB, a Meilisearch, and a LibreChat.
 
-![Project Detail](https://i.imgur.com/4SRMoba.png)
+![Project Detail](https://github.com/danny-avila/LibreChat/assets/32828263/7fed136c-0490-4df7-892e-43d681723d95)
 
 To access your deployed LibreChat, you need to select the LibreChat service, click on the Network tab below, and then click Generate Domain to create a subdomain under .zeabur.app.
 
-![Bind domain](https://i.imgur.com/2RabEIF.png)
+![Bind domain](https://github.com/danny-avila/LibreChat/assets/32828263/d324a759-9812-456c-a295-014184bf5e99)
 
 ## Conclusion
 
 You can now access it by clicking the link.
 
-![](https://i.imgur.com/o4k3HYA.png)
+![](https://github.com/danny-avila/LibreChat/assets/32828263/b3f64d10-d5c7-4b26-8414-fa772e8a51fd)
 
 Congratulations! You've successfully deployed LibreChat on Zeabur.

docs/general_info/breaking_changes.md

@@ -9,6 +9,57 @@ 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.
 
+## **.env** changes v0.6.6 -> v0.6.9
+see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more info
+
+- Assistants added to the list
+```sh
+# ENDPOINTS=openAI,assistants,azureOpenAI,bingAI,chatGPTBrowser,google,gptPlugins,anthropic
+```
+- Updated OpenAI models
+```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
+```
+- Assistants configuration
+```sh
+#====================#
+#   Assistants API   #
+#====================#
+
+# ASSISTANTS_API_KEY=
+# 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
+```
+- Updated Plugin models
+```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
+```
+- Birthday hat
+```sh
+# SHOW_BIRTHDAY_ICON=true
+```
+### Previous changes:
+- DALL-E
+```sh
+# DALL·E
+#----------------
+# DALLE_API_KEY=
+# DALLE3_API_KEY=
+# DALLE2_API_KEY=
+# DALLE3_SYSTEM_PROMPT=
+# DALLE2_SYSTEM_PROMPT=
+# DALLE_REVERSE_PROXY=
+# DALLE3_BASEURL=
+# DALLE2_BASEURL=
+
+# DALL·E (via Azure OpenAI)
+# Note: requires some of the variables above to be set
+#----------------
+# DALLE3_AZURE_API_VERSION=
+# DALLE2_AZURE_API_VERSION=
+```
+
+
 ## January 31th 2024
 - A new method to use the ChatGPT endpoint is now documented. It uses "Ninja"
 - For more info:

docs/install/configuration/docker_override.md

@@ -36,7 +36,9 @@ Make your desired changes by uncommenting the relevant sections and customizing
 
 > Warning: You can only specify every service name once (api, mongodb, meilisearch, ...) If you want to override multiple settings in one service you will have to edit accordingly.
 
-For example, if you want to make sure Docker can use your `librechat.yaml` file for [custom configuration](./custom_config.md), it would look like this:
+### Examples
+
+If you want to make sure Docker can use your `librechat.yaml` file for [custom configuration](./custom_config.md), it would look like this:
 
 ```yaml
 version: '3.4'
@@ -47,7 +49,7 @@ services:
       - ./librechat.yaml:/app/librechat.yaml
 ```
 
-Or, if you want to use a prebuilt image for the `api` service, use the LibreChat config file, and expose MongoDB's port, your `docker-compose.override.yml` might look like this:
+Or, if you want to use a prebuilt image for the `api` service, use the LibreChat config file, and use the older Mongo that doesn't requires AVX support, your `docker-compose.override.yml` might look like this:
 
 ```yaml
 version: '3.4'
@@ -59,11 +61,10 @@ services:
     image: ghcr.io/danny-avila/librechat-dev:latest
 
   mongodb:
-    ports:
+    image: mongo:4.4.18
-      - 27018:27017
 ```
 
-> Note: Be cautious with exposing ports like MongoDB to the public, as it can make your database vulnerable to attacks.
+> Note: Be cautious if you expose ports for MongoDB or Meilisearch to the public, as it can make your data vulnerable.
 
 ## Step 3: Apply the changes
 

docs/install/configuration/dotenv.md

@@ -841,3 +841,26 @@ Mail address for from field. It is **REQUIRED** to set a value here (even if it'
 ```bash
 EMAIL_FROM=noreply@librechat.ai 
 ```
+
+### Other
+
+- **Redis:** Redis support is experimental, you may encounter some problems when using it. 
+
+> If using Redis, you should flush the cache after changing any LibreChat settings
+
+```bash
+REDIS_URI=
+USE_REDIS=
+```
+
+- **Birthday Hat:** Give the AI Icon a Birthday Hat 🥳
+
+> Will show automatically on February 11th (LibreChat's birthday)
+ 
+> Set this to `false` to disable the birthday hat
+
+> Set to `true` to enable all the time.
+
+```bash
+SHOW_BIRTHDAY_ICON=true
+```