diff --git a/README.md b/README.md index 50f9d02a93..e80334deef 100644 --- a/README.md +++ b/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 + + +[![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)
diff --git a/client/src/components/Endpoints/BingAI/Settings.jsx b/client/src/components/Endpoints/BingAI/Settings.jsx index fc6e65c507..19c5b7e75f 100644 --- a/client/src/components/Endpoints/BingAI/Settings.jsx +++ b/client/src/components/Endpoints/BingAI/Settings.jsx @@ -111,7 +111,7 @@ function Settings(props) { style={{ opacity: showSystemMessage ? '1' : '0' }} > ` 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. \ No newline at end of file diff --git a/docs/install/windows_install.md b/docs/install/windows_install.md index db7b1a72cd..251195f5b7 100644 --- a/docs/install/windows_install.md +++ b/docs/install/windows_install.md @@ -1,17 +1,48 @@ -# Windows Install +# Windows Installation Guide -## **Recommended: [Docker Install](docker_install.md)** +## **Recommended:** -**or** -## **[Windows Installer](https://github.com/fuegovic/LibreChat-Windows-Installer)** +[![Watch the video](https://img.youtube.com/vi/naUHHqpyOo4/maxresdefault.jpg)](https://youtu.be/naUHHqpyOo4) +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 -### Install the prerequisites on your machine +## **Manual Installation** +## 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 - - 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) +## [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) -#### To setup the app: +## Using the command line (in the root directory) +### 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 ` (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" -start "MeiliSearch" cmd /k "meilisearch --master-key + ```bat title="LibreChat.bat" + start "MeiliSearch" cmd /k "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` diff --git a/mkdocs.yml b/mkdocs.yml index b66b076b16..5e9ee06b9a 100644 --- a/mkdocs.yml +++ b/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'