docs: updates (#662)

* docs: updates

* docs: updates

* Update Settings.jsx

README.md

@@ -31,7 +31,10 @@ LibreChat brings together the future of assistant AIs with the revolutionary tec
 
 With LibreChat, you no longer need to opt for ChatGPT Plus and can instead use free or pay-per-call APIs. We welcome contributions, cloning, and forking to enhance the capabilities of this advanced chatbot platform.
   
-https://github.com/danny-avila/LibreChat/assets/110412045/c1eb0c0f-41f6-4335-b982-84b278b53d59
+<!-- https://github.com/danny-avila/LibreChat/assets/110412045/c1eb0c0f-41f6-4335-b982-84b278b53d59 -->
+
+[![Watch the video](https://img.youtube.com/vi/pNIOs1ovsXw/maxresdefault.jpg)](https://youtu.be/pNIOs1ovsXw)
+Click on the thumbnail to open the video☝️
 
 # Features
 - Response streaming identical to ChatGPT through server-sent events
@@ -44,7 +47,9 @@ https://github.com/danny-avila/LibreChat/assets/110412045/c1eb0c0f-41f6-4335-b98
 
 ---
 
-## ⚠️ [Breaking Changes as of v0.5.0](docs/general_info/breaking_changes.md#v050) ⚠️
+## ⚠️ [Breaking Changes](docs/general_info/breaking_changes.md) ⚠️
+**Applies to [v0.5.4](docs/general_info/breaking_changes.md#v054) & [v0.5.5](docs/general_info/breaking_changes.md#v055)**
+
 **Please read this before updating from a previous version**
 
 ---
@@ -65,6 +70,7 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
   * [Windows Install](docs/install/windows_install.md)
   * [APIs and Tokens](docs/install/apis_and_tokens.md)
   * [User Auth System](docs/install/user_auth_system.md)
+  * [Online MongoDB Database](docs/install/mongodb.md)
 </details>
 
 <details>

client/src/components/Endpoints/BingAI/Settings.jsx

@@ -111,7 +111,7 @@ function Settings(props) {
                 style={{ opacity: showSystemMessage ? '1' : '0' }}
               >
                 <a
-                  href="https://github.com/danny-avila/LibreChat/blob/main/client/defaultSystemMessage.md"
+                  href="https://github.com/danny-avila/LibreChat/blob/main/docs/features/bing_jailbreak.md#default-system-message-for-jailbreak-mode-sydney"
                   target="_blank"
                   className="text-blue-500 transition-colors duration-200 hover:text-blue-800 dark:text-blue-400 dark:hover:text-blue-500"
                   rel="noreferrer"

docs/deployment/render.md

@@ -76,73 +76,9 @@ Also:
 
 ## Create and Configure your Database
 
-The last thing you need is to create a MongoDB Atlas Database.
+The last thing you need is to create a MongoDB Atlas Database and get your connection string.
-
-**1.** Open a new tab and go to [https://account.mongodb.com/account/register](https://account.mongodb.com/account/register) to create an account
-
-**2.** Once you have set up your account, create a new project and name it:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/5cdeeba0-2982-47c3-8228-17e8500fd0d7)
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/97da7454-63a9-42dc-8eeb-7a3ae861c7c4)
-
-**3.** Now select build a database:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/f6fc986e-83fe-472c-a720-618c27bab801)
-
-**4.** Select the free tier:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/87037310-52f6-4217-822b-d47168464067)
-
-**5.** Name your cluster (leave everything else default) and click create:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/e8aa62b5-ff85-4c76-befc-2a99563e6c81)
-
-**6.** Enter a user name and a secure password:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/df2c407f-2124-4c5e-bc0e-f5868811e59d)
-
-**7.** Select Cloud environement:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/1b0d3cae-2e87-4330-920c-61be1589f041)
-
-**8.** Click /Finish and Close:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/103f8958-2744-42ab-9cda-75c2f33296cb)
-
-**9.** Go to database:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/9c487530-8b4a-4db0-8e56-cb06f7c2ff74)
-
-**10.** Click on network access in the side menu:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/29f287ee-caa1-4a2b-a705-bcb33f4735bb)
-
-**11.** Add a IP Adress:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/b870fa3f-9da2-4e2e-bd00-20bc0a67b562)
-
-**12.** Select allow access from everywhere and confirm:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/5cd80bda-ae6d-48f0-94c1-67b122b68357)
-
-**13.** Now Select Database in the side menu:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/55d15f51-b890-4664-8d0a-686597984e2f)
-
-**14.** Connect:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/198ca6cf-8a90-4b95-b7f7-1149a09fddfe)
-
-**15.** Select the first option (driver)
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/d8aaf0e4-285d-4e76-bb78-591355569da7)
-
-**16.** Copy the connection string:
-
-  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/ccc52648-39fa-4f45-8e2b-96c93ffede4a)
-
 
+Follow the instructions in this document: [Online MongoDB Database](..\install\mongodb.md)
 
 ## Complete the Environment Variables configuration 
 

docs/general_info/breaking_changes.md

@@ -1,5 +1,57 @@
 # ⚠️ **Breaking Changes** ⚠️
 
+## v0.5.5
+Some users have reported an error after updating their docker containers.
+
+![image](https://github.com/fuegovic/LibreChat/assets/32828263/1265d664-5a9c-47d2-b405-47bc0d029a8d)
+
+- To fix this error, you need to:
+  - Delete the LibreChat image in docker 🗑️
+    
+    **(leave mongo intact to preserve your profiles and history)** 
+    ![image](https://github.com/fuegovic/LibreChat/assets/32828263/acf15682-435e-44bd-8873-a5dceb3121cc)
+  - Repeat the docker update process: 🚀
+    - `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.**
+
+- If you previously used social login, you need to:
+  - Add this to your .env file: 👇
+
+```env
+##########################
+# User System:
+##########################
+
+# Allow Public Registration
+ALLOW_REGISTRATION=true
+
+# Allow Social Registration
+ALLOW_SOCIAL_LOGIN=false
+```
+
+  - Set ALLOW_SOCIAL_LOGIN to true if you want to enable social login 🔥
+
+- If you want to enable the Anthropic Endpoint (Claude), you need to:
+  - Add this part in your .env file: 👇
+
+```env
+##########################
+# Anthropic Endpoint: 
+##########################
+# Access key from https://console.anthropic.com/
+# Leave it blank to disable this feature.
+# Set to "user_provided" to allow the user to provide their API key from the UI.
+# Note that access to claude-1 may potentially become unavailable with the release of claude-2.
+ANTHROPIC_API_KEY="user_provided"
+ANTHROPIC_MODELS=claude-1,claude-instant-1,claude-2
+```
+
+  - Choose from ANTHROPIC_MODELS which models you want to enable 🤖
+
 ## v0.5.0
 
 **Note: These changes only apply to users who are updating from a previous version of the app.**

docs/index.md

@@ -37,7 +37,7 @@ With LibreChat, you no longer need to opt for ChatGPT Plus and can instead use f
   <iframe 
     width="1000" 
     height="500" 
-    src="https://www.youtube.com/embed/0NqT98CY8ag?controls=1?autoplay=1&mute=1&loop=1" 
+    src="https://www.youtube.com/embed/pNIOs1ovsXw?controls=1?autoplay=1&mute=1&loop=1" 
     title="Librechat Overview" 
     frameborder="0" 
     allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share; loop" 
@@ -57,6 +57,13 @@ With LibreChat, you no longer need to opt for ChatGPT Plus and can instead use f
 
 ---
 
+## ⚠️ [Breaking Changes](general_info/breaking_changes.md) ⚠️
+**Applies to [v0.5.4](general_info/breaking_changes.md#v054) & [v0.5.5](general_info/breaking_changes.md#v055)**
+
+**Please read this before updating from a previous version**
+
+---
+
 ## Star History
 
 [![Star History Chart](https://api.star-history.com/svg?repos=danny-avila/LibreChat&type=Date)](https://star-history.com/#danny-avila/LibreChat&Date)

docs/install/docker_install.md

@@ -2,6 +2,7 @@
 
 Docker installation is recommended for most use cases. It's the easiest, simplest, and most reliable method to get started.
 
+See the video guide for [Windows](windows_install.md#recommended) or [Ubuntu 22.04 LTS](linux_install.md#recommended)
 ## Installation and Configuration
 
 ### Preparation
@@ -109,18 +110,7 @@ To update LibreChat. enter these commands one after the other from the root dir:
 
 ### **[LibreChat on Docker Hub](https://hub.docker.com/r/chatgptclone/app/tags)**
 
-### **Create a MongoDB database** (Not required if you'd like to use the local database installed by Docker)
+### **[Create a MongoDB database](mongodb.md)** (Not required if you'd like to use the local database installed by Docker)
-
-Navigate to https://www.mongodb.com/ and Sign In or Create an account
-
-- Create a new project
-- Build a Database using the free plan and name the cluster (example: LibreChat)
-- Use the "Username and Password" method for authentication
-- Add your current IP to the access list
-- In the Database Deployment tab, click on Connect
-- "Choose a connection method" select "Connect your application"
-- Driver = Node.js / Version = 4.1 or later
-- Copy the connection string, fill in your password and remove `&w=majority` from default connection string.
 
 ---
 

docs/install/linux_install.md

@@ -1,7 +1,43 @@
-# Linux Installation
+# Linux Installation Guide
-## **Recommended: [Docker Install](docker_install.md)**
+## **Recommended:**
+
+[![Watch the video](https://img.youtube.com/vi/w7VqivpdfZk/maxresdefault.jpg)](https://youtu.be/w7VqivpdfZk)
+Click on the thumbnail to open the video☝️
+---
+
+In this video, you will learn how to install and run LibreChat, using Docker on Ubuntu 22.04 LTS.
+
+#### Timestamps
+
+- 0:00 - Intro
+- 0:14 - Update the system
+- 0:29 - Clone the repository
+- 0:37 - Docker installation 
+- 1:03 - Enter in the folder
+- 1:07 - Create the .env file
+- 1:14 - Build using docker-compose
+- 1:29 - Start LibreChat
+- 1:43 - Test
+
+#### Instructions
+
+Here are the steps to follow:
+- Update the system: `sudo apt update`
+- Clone LibreChat: `git clone https://github.com/danny-avila/LibreChat.git`
+- Install Docker: `sudo apt install docker.io && apt install docker-compose -y`
+- Enter the folder: `cd LibreChat`
+- Create the .env file: `cp .env.example .env`
+- Build the Docker image: `docker-compose build`
+- Start LibreChat: `docker-compose up -d`
+
+Note: If you run the command on the same computer and want to access it, navigate to `localhost:3080`. You should see a login page where you can create or sign in to your account. Then you can choose an AI model and start chatting. 
+
+Have fun!
 
 ---
+## **[Docker Install](docker_install.md)** (General documentation)
+--- 
+
 ## **Manual Installation:**
 
 ## Prerequisites
@@ -50,17 +86,7 @@ curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
 sudo apt-get install -y nodejs
 ```
 
-## Create a MongoDB database:
+## [Create a MongoDB database](mongodb.md) (Required)
-
-- Navigate to https://www.mongodb.com/ and sign in or create an account.
-- Create a new project.
-- Build a Database using the free plan and name the cluster (example: LibreChat).
-- Use the "Username and Password" method for authentication.
-- Add your current IP to the access list.
-- Then in the Database Deployment tab click on Connect.
-- In "Choose a connection method" select "Connect your application".
-- Driver = Node.js / Version = 4.1 or later.
-- Copy the connection string and save it somewhere (you will need it later).
 
 ## [Get Your API keys and Tokens](apis_and_tokens.md) (Required)
 - You must set up at least one of these tokens or APIs to run the app.

docs/install/mac_install.md

@@ -1,4 +1,4 @@
-# Mac Install
+# Mac Installation Guide
 ## **Recommended : [Docker Install](docker_install.md)**
 
 ---
@@ -9,19 +9,6 @@
   - Install Homebrew (if not already installed) by following the instructions on https://brew.sh/
   - Install Node.js and npm by running `brew install node`
   - Install MongoDB (if not using Docker) by running `brew tap mongodb/brew` and `brew install mongodb-community`
-  
-  - **Create a MongoDB database**
-    
-    - Navigate to https://www.mongodb.com/ and Sign In or Create an account
-    - Create a new project
-    - Build a Database using the free plan and name the cluster (example: LibreChat)
-    - Use the "Username and Password" method for authentication
-    - Add your current IP to the access list
-    - Then in the Database Deployment tab click on Connect
-    - In "Choose a connection method" select "Connect your application"
-    - Driver = Node.js / Version = 4.1 or later
-    - Copy the connection string and save it somewhere(you will need it later)
-
 
  ## Instructions:
 
@@ -29,6 +16,8 @@
   - Change into the cloned directory by running cd LibreChat
   - If using MongoDB Atlas, remove &w=majority from the default connection string
 Follow the instructions for setting up proxies, access tokens, and user system:
+  
+## [Create a MongoDB database](mongodb.md) (Required)
 
 ## [Get Your API keys and Tokens](apis_and_tokens.md) (Required)
 - You must set up at least one of these tokens or APIs to run the app.

docs/install/mongodb.md

@@ -0,0 +1,89 @@
+# Set Up an Online MongoDB Database
+
+## Create an account
+- Open a new tab and go to [https://account.mongodb.com/account/register](https://account.mongodb.com/account/register) to create an account.
+
+## Create a project
+- Once you have set up your account, create a new project and name it:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/5cdeeba0-2982-47c3-8228-17e8500fd0d7)
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/97da7454-63a9-42dc-8eeb-7a3ae861c7c4)
+
+## Build a database
+- Now select `Build a Database`:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/f6fc986e-83fe-472c-a720-618c27bab801)
+
+## Choose your cloud environment
+- Select the free tier:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/87037310-52f6-4217-822b-d47168464067)
+
+## Name your cluster
+- Name your cluster (leave everything else default) and click create:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/e8aa62b5-ff85-4c76-befc-2a99563e6c81)
+
+## Database credentials
+- Enter a user name and a secure password:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/df2c407f-2124-4c5e-bc0e-f5868811e59d)
+
+## Select environment
+- Select `Cloud Environement`:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/1b0d3cae-2e87-4330-920c-61be1589f041)
+
+## Complete database configuration
+- Click `Finish and Close`:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/103f8958-2744-42ab-9cda-75c2f33296cb)
+
+## Go to your database
+- Click `Go to Databases`:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/9c487530-8b4a-4db0-8e56-cb06f7c2ff74)
+
+## Network access
+- Click on `Network Access` in the side menu:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/29f287ee-caa1-4a2b-a705-bcb33f4735bb)
+
+## Add IP adress
+- Add a IP Adress:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/b870fa3f-9da2-4e2e-bd00-20bc0a67b562)
+
+## Allow access
+- Select `Allow access from anywhere` and `Confirm`:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/5cd80bda-ae6d-48f0-94c1-67b122b68357)
+
+## Get your connection string
+
+- Select `Database` in the side menu
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/55d15f51-b890-4664-8d0a-686597984e2f)
+
+- Select `Connect`:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/198ca6cf-8a90-4b95-b7f7-1149a09fddfe)
+
+
+- Select the first option (`Drivers`)
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/d8aaf0e4-285d-4e76-bb78-591355569da7)
+
+ 
+- Copy the `connection string`:
+
+  ![image](https://github.com/fuegovic/LibreChat/assets/32828263/ccc52648-39fa-4f45-8e2b-96c93ffede4a)
+
+- Make sure to replace `<password>` with the database password you created in the "[database credentials](#database-credentials)" section above. Do not forget to remove the `<` `>` around the password. Also remove `&w=majority` at the end of the connection string.
+- example:
+```
+mongodb+srv://fuegovic:1Gr8Banana@render-librechat.fgycwpi.mongo.net/?retryWrites=true
+```
+
+### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/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.

docs/install/windows_install.md

@@ -1,17 +1,48 @@
-# Windows Install
+# Windows Installation Guide
 
-## **Recommended: [Docker Install](docker_install.md)**
+## **Recommended:**
 
-**or**
+[![Watch the video](https://img.youtube.com/vi/naUHHqpyOo4/maxresdefault.jpg)](https://youtu.be/naUHHqpyOo4)
-## **[Windows Installer](https://github.com/fuegovic/LibreChat-Windows-Installer)**
+Click on the thumbnail to open the video☝️
+---
+
+In this video we're going to install LibreChat on Windows 11 using Docker and Git.
+
+#### Timestamps
+0:00 - Intro
+0:10 - Requirements
+0:31 - Docker Installation
+1:50 - Git Installation
+2:27 - LibreChat Installation
+3:07 - Start LibreChat
+3:59 - Access to LibreChat
+4:23 - Outro
+
+#### Instructions
+- To install LibreChat, you need Docker desktop and Git. Download them from these links:
+  - Docker desktop: https://www.docker.com/products/docke...
+  - Git: https://git-scm.com/download/win
+- Follow the steps in the video to install and run Docker desktop and Git.
+- Open a terminal in the root of the C drive and enter these commands:
+  - `git clone https://github.com/danny-avila/LibreC...`
+  - `cd LibreChat`
+  - `cp .env.example .env`
+  - `docker-compose up`
+- Visit http://localhost:3080/ to access LibreChat. Create an account and start chatting.
+
+Have fun!
+
+--- 
+## **Other installation methods:**
+### **[Windows Installer](https://github.com/fuegovic/LibreChat-Windows-Installer)**
 (Includes a Startup and Update Utility)
 
 ---
 
-## Manual Installation
+## **Manual Installation**
-### Install the prerequisites on your machine
+## Install the prerequisites on your machine
 
-### **Download LibreChat**
+## **Download LibreChat**
    
   - Download the latest release here: https://github.com/danny-avila/LibreChat/releases/
   - Or by clicking on the green code button in the top of the page and selecting "Download ZIP"
@@ -19,7 +50,7 @@
   - If you downloaded a zip file, extract the content in "C:/LibreChat/" 
   - **IMPORTANT : If you install the files somewhere else modify the instructions accordingly**
   
-### **Enable the Conversation search feature:** (optional)
+## **Enable the Conversation search feature:** (optional)
 		
   - Download MeiliSearch latest release from : https://github.com/meilisearch/meilisearch/releases
   - Copy it to "C:/LibreChat/"
@@ -27,41 +58,31 @@
   - Open it by double clicking on it
   - Copy the generated Master Key and save it somewhere (You will need it later)
 
-### **Download and Install Node.js**
+## **Download and Install Node.js**
     
   - Navigate to https://nodejs.org/en/download and to download the latest Node.js version for your OS (The Node.js installer includes the NPM package manager.)
     
-### **Create a MongoDB database**
+## [Create a MongoDB database](mongodb.md) (Required)
     
-  - Navigate to https://www.mongodb.com/ and Sign In or Create an account
+## [Get Your API keys and Tokens](apis_and_tokens.md) (Required)
-  - Create a new project
-  - Build a Database using the free plan and name the cluster (example: LibreChat)
-  - Use the "Username and Password" method for authentication
-  - Add your current IP to the access list
-  - Then in the Database Deployment tab click on Connect
-  - In "Choose a connection method" select "Connect your application"
-  - Driver = Node.js / Version = 4.1 or later
-  - Copy the connection string and save it somewhere(you will need it later)
-    
-### [Get Your API keys and Tokens](apis_and_tokens.md) (Required)
 - You must set up at least one of these tokens or APIs to run the app.
 
-### [User/Auth System](../install/user_auth_system.md) (Optional)
+## [User/Auth System](../install/user_auth_system.md) (Optional)
 - How to set up the user/auth system and Google login.
 
 ## Setup and Run the app
 
-### Using the command line (in the root directory)
+## Using the command line (in the root directory)
-#### To setup the app:
+### To setup the app:
 1. Run `npm ci` (this step will also create the env file)
 2. Run `npm run frontend`
 
-#### To use the app:
+### To use the app:
 1. Run `npm run backend`
 2. Run `meilisearch --master-key <meilisearch_Master_Key>` (Only if SEARCH=TRUE)
 3. Visit http://localhost:3080 (default port) & enjoy
 
-#### Using a batch file
+### Using a batch file
 
 - **Make a batch file to automate the starting process**
   - Open a text editor
@@ -71,16 +92,18 @@
   - Save the file as "C:/LibreChat/LibreChat.bat"
   - you can make a shortcut of this batch file and put it anywhere
 
-``` bat title="LibreChat.bat"
+  ```bat title="LibreChat.bat"
-start "MeiliSearch" cmd /k "meilisearch --master-key <meilisearch_Master_Key>
+  start "MeiliSearch" cmd /k "meilisearch --master-key <meilisearch_Master_Key>
 
-start "LibreChat" cmd /k "npm run backend"
+  start "LibreChat" cmd /k "npm run backend"
 
-REM this batch file goes at the root of the LibreChat directory (C:/LibreChat/)
+  REM this batch file goes at the root of the LibreChat directory (C:/LibreChat/)
-```
+  ```
-##
+
+---
 
 ## **Update**
+To update LibreChat:
 - run `git pull` from the root dir
 - Run npm ci from root directory `npm ci`
 - Build the client by running `npm run frontend`

mkdocs.yml

@@ -87,6 +87,7 @@ nav:
     - Windows Install: 'install/windows_install.md'
     - APIs and Tokens: 'install/apis_and_tokens.md'
     - User Auth System: 'install/user_auth_system.md'
+    - Online MongoDB Database: 'install/mongodb.md'
   - Features:
     - Plugins:
       - Introduction: 'features/plugins/introduction.md'