From aaa20309a08b127cdaa0e1e4efa1d1208514e84a Mon Sep 17 00:00:00 2001 From: Fuegovic <32828263+fuegovic@users.noreply.github.com> Date: Tue, 6 Jun 2023 07:44:53 -0400 Subject: [PATCH] Update: install docs (LibreChat) (#458) * Release: rename project from ChatGPT Clone to LibreChat Release: rename project from ChatGPT Clone to LibreChat * Release: rename project from ChatGPT Clone to LibreChat Release: rename project from ChatGPT Clone to LibreChat * Release: rename project from ChatGPT Clone to LibreChat Release: rename project from ChatGPT Clone to LibreChat * Release: rename project from ChatGPT Clone to LibreChat Release: rename project from ChatGPT Clone to LibreChat * Update documentation_guidelines.md --- .../contributions/documentation_guidelines.md | 3 +- docs/install/docker_install.md | 22 +++--- docs/install/linux_install.md | 20 ++--- docs/install/mac_install.md | 40 +++++----- docs/install/windows_install.md | 79 ++++++++++--------- 5 files changed, 85 insertions(+), 79 deletions(-) diff --git a/docs/contributions/documentation_guidelines.md b/docs/contributions/documentation_guidelines.md index 3f140aab4d..5e30201517 100644 --- a/docs/contributions/documentation_guidelines.md +++ b/docs/contributions/documentation_guidelines.md @@ -3,7 +3,8 @@ - ## ⚠️Keep it organized and structured⚠️ - For new features, create new documents and place them in the appropriate folder(s) - When you create a new document, do not forget to add it to the table of content - - Add a shortcut that point back to the [README.MD](../../README.md) in the new documents + - Add a shortcut that point back to the [README.MD](../../README.md) in the bottom of new documents (look at other docs for example) + - Use `#` / `##` / `###` for the different section of the doc - Do not add unrelated information to an existing document, create a new one if needed - For incremental updates, you need to update the main **README.MD** and **CHANGELOG.MD** - In the main README update the part where the last version is shown and the features section if needed diff --git a/docs/install/docker_install.md b/docs/install/docker_install.md index 0ab889d9d9..3479f714f5 100644 --- a/docs/install/docker_install.md +++ b/docs/install/docker_install.md @@ -26,7 +26,7 @@ - **Clone/download** the repo down where desired ```bash - git clone https://github.com/danny-avila/chatgpt-clone.git + git clone https://github.com/danny-avila/LibreChat.git ``` ## @@ -49,18 +49,18 @@ Navigate to https://www.mongodb.com/ and Sign In or Create an account - To get your Access token for ChatGPT 'Free Version', log in to chat.openai.com, then visit https://chat.openai.com/api/auth/session. - Warning: There may be a high chance of your account being banned with this method. Continue doing so at your own risk. -## +### **Get your Bing Access Token** - **Get your Bing Access Token** + ⚠️**For better results, please follow these [new instructions](https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302)** + + or - Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)** - - ~~Using MS Edge, navigate to bing.com~~ - - ~~Make sure you are logged in~~ - - ~~Open the DevTools by pressing F12 on your keyboard~~ - - ~~Click on the tab "Application" (On the left of the DevTools)~~ - - ~~Expand the "Cookies" (Under "Storage")~~ - - ~~Copy the value of the "\_U" cookie~~ + Using MS Edge, navigate to bing.com + - Make sure you are logged in + - Open the DevTools by pressing F12 on your keyboard + - Click on the tab "Application" (On the left of the DevTools) + - Expand the "Cookies" (Under "Storage") + - Copy the value of the "\_U" cookie ## diff --git a/docs/install/linux_install.md b/docs/install/linux_install.md index b535f95a6c..f2f14e7ecd 100644 --- a/docs/install/linux_install.md +++ b/docs/install/linux_install.md @@ -18,7 +18,7 @@ Before installing ChatGPT-Clone, make sure your machine has the following prereq ## 1. Clone the repository: ```bash -git clone https://github.com/danny-avila/chatgpt-clone.git +git clone https://github.com/danny-avila/LibreChat.git ``` ## 2. Extract the content in your desired location: @@ -69,15 +69,17 @@ sudo apt-get install -y nodejs - Visit https://platform.openai.com/account/api-keys and save your API key somewhere safe (you will need it later) ## 7. Get your Bing Access Token + + ⚠️**For better results, please follow these [new instructions](https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302)** + + or - Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)** - - ~~Using MS Edge, navigate to bing.com~~ - - ~~Make sure you are logged in~~ - - ~~Open the DevTools by pressing F12 on your keyboard~~ - - ~~Click on the tab "Application" (On the left of the DevTools)~~ - - ~~Expand the "Cookies" (Under "Storage")~~ - - ~~Copy the value of the "\_U" cookie~~ + Using MS Edge, navigate to bing.com + - Make sure you are logged in + - Open the DevTools by pressing F12 on your keyboard + - Click on the tab "Application" (On the left of the DevTools) + - Expand the "Cookies" (Under "Storage") + - Copy the value of the "\_U" cookiee ## 8. Create the ".env" File diff --git a/docs/install/mac_install.md b/docs/install/mac_install.md index 40efbc9b24..f6da35f80a 100644 --- a/docs/install/mac_install.md +++ b/docs/install/mac_install.md @@ -25,32 +25,34 @@ ## Instructions: - - Open Terminal and clone the repository by running git clone https://github.com/danny-avila/chatgpt-clone.git - - Change into the cloned directory by running cd chatgpt-clone + - Open Terminal and clone the repository by running `git clone https://github.com/danny-avila/LibreChat.git` + - 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: -### Access Tokens: +## Access Tokens: -**Get your OpenAI API key** +### **Get your OpenAI API key** - here: https://platform.openai.com/account/api-keys and save it somewhere safe (you will need it later) -**ChatGPT Free Instructions:** +### **ChatGPT Free Instructions:** - To get your Access token for ChatGPT 'Free Version', log in to chat.openai.com, then visit https://chat.openai.com/api/auth/session. - Warning: There may be a high chance of your account being banned with this method. Continue doing so at your own risk. -**Get your Bing Access Token** +### **Get your Bing Access Token** + + ⚠️**For better results, please follow these [new instructions](https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302)** + + or - Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)** - - ~~Using MS Edge, navigate to bing.com~~ - - ~~Make sure you are logged in~~ - - ~~Open the DevTools by pressing F12 on your keyboard~~ - - ~~Click on the tab "Application" (On the left of the DevTools)~~ - - ~~Expand the "Cookies" (Under "Storage")~~ - - ~~Copy the value of the "\_U" cookie~~ + Using MS Edge, navigate to bing.com + - Make sure you are logged in + - Open the DevTools by pressing F12 on your keyboard + - Click on the tab "Application" (On the left of the DevTools) + - Expand the "Cookies" (Under "Storage") + - Copy the value of the "\_U" cookie ## Setup Instruction @@ -58,17 +60,17 @@ Follow the instructions for setting up proxies, access tokens, and user system: - Run npm ci from root directory `npm ci` - Build the client by running `npm run frontend` -**Download MeiliSearch for macOS (optional):** +### **Download MeiliSearch for macOS (optional):** - You can download the latest MeiliSearch binary for macOS from their GitHub releases page: https://github.com/meilisearch/MeiliSearch/releases. Look for the file named meilisearch-macos-amd64 (or the equivalent for your system architecture) and download it. -**Make the binary executable:** +### **Make the binary executable:** - Open Terminal and navigate to the directory where you downloaded the MeiliSearch binary. Run the following command to make it executable: ``` chmod +x meilisearch-macos-amd64 ``` -**Run MeiliSearch:** +### **Run MeiliSearch:** - Now that the binary is executable, you can start MeiliSearch by running the following command, replacing your_master_key_goes_here with your desired master key: ``` @@ -102,13 +104,13 @@ fi npm run backend ``` -**Make the script executable by running** +### **Make the script executable by running** ``` chmod +x start_chatgpt.sh ``` - **Start ChatGPT-Clone by running** +### **Start ChatGPT-Clone by running** ``` ./start_chatgpt.sh ``` diff --git a/docs/install/windows_install.md b/docs/install/windows_install.md index 1b98d654c9..64c937bb9d 100644 --- a/docs/install/windows_install.md +++ b/docs/install/windows_install.md @@ -1,63 +1,64 @@ # Windows Install -### Recommended: -### **[Docker](docker_install.md)** +### Recommended: **[Docker](docker_install.md)** or -### **[Automated Installer (Windows)](https://github.com/fuegovic/chatgpt-clone-local-installer)** +### **[Windows Installer](https://github.com/fuegovic/LibreChat-Windows-Installer)** (Includes a Startup and Update Utility) ## ## Manual Installation ### Install the prerequisites on your machine - - **Download chatgpt-clone** +### **Download chatgpt-clone** - - Download the latest release here: https://github.com/danny-avila/chatgpt-clone/releases/ - - Or by clicking on the green code button in the top of the page and selecting "Download ZIP" - - Or (Recommended if you have Git installed) pull the latest release from the main branch - - If you downloaded a zip file, extract the content in "C:/chatgpt-clone/" - - **IMPORTANT : If you install the files somewhere else modify the instructions accordingly** + - 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" + - Open Terminal (command prompt) and clone the repository by running `git clone https://github.com/danny-avila/LibreChat.git` + - If you downloaded a zip file, extract the content in "C:/chatgpt-clone/" + - **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:/chatgpt-clone/" - - Rename the file to "meilisearch.exe" - - Open it by double clicking on it - - Copy the generated Master Key and save it somewhere (You will need it later) + - Download MeiliSearch latest release from : https://github.com/meilisearch/meilisearch/releases + - Copy it to "C:/chatgpt-clone/" + - Rename the file to "meilisearch.exe" + - 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.) + - 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** - - 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: chatgpt-clone) - - 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) + - 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: chatgpt-clone) + - 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 OpenAI API key** - - here: https://platform.openai.com/account/api-keys and save it somewhere safe (you will need it later) +### **Get your OpenAI API key** + - here: https://platform.openai.com/account/api-keys and save it somewhere safe (you will need it later) - **Get your Bing Access Token** +### **Get your Bing Access Token** + + ⚠️**For better results, please follow these [new instructions](https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302)** + + or - Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)** - - ~~Using MS Edge, navigate to bing.com~~ - - ~~Make sure you are logged in~~ - - ~~Open the DevTools by pressing F12 on your keyboard~~ - - ~~Click on the tab "Application" (On the left of the DevTools)~~ - - ~~Expand the "Cookies" (Under "Storage")~~ - - ~~Copy the value of the "\_U" cookie~~ + Using MS Edge, navigate to bing.com + - Make sure you are logged in + - Open the DevTools by pressing F12 on your keyboard + - Click on the tab "Application" (On the left of the DevTools) + - Expand the "Cookies" (Under "Storage") + - Copy the value of the "\_U" cookie -- **Create the ".env" File** +### **Create the ".env" File** You will need all your credentials, (API keys, access tokens, and Mongo Connection String, MeileSearch Master Key) - Open "C:/chatgpt-clone/api/.env.example" in a text editor - At this line **MONGO_URI="mongodb://127.0.0.1:27017/chatgpt-clone"**