Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-17 00:40:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Update: install docs (LibreChat) (#458)

Browse source 
* 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
This commit is contained in:
Fuegovic 2023-06-06 07:44:53 -04:00 • committed by GitHub
parent 8c4a3b2729
commit aaa20309a0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 85 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/contributions/documentation_guidelines.md
View file

@ -3,7 +3,8 @@
- ## ⚠️Keep it organized and structured⚠️ - ## ⚠️Keep it organized and structured⚠️
- For new features, create new documents and place them in the appropriate folder(s) - 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 - 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 - 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** - 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 - In the main README update the part where the last version is shown and the features section if needed

20
docs/install/docker_install.md
View file

@ -26,7 +26,7 @@
- **Clone/download** the repo down where desired - **Clone/download** the repo down where desired
```bash ```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. - 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. - 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)**
Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)** or
~~Using MS Edge, navigate to bing.com~~ Using MS Edge, navigate to bing.com
- ~~Make sure you are logged in~~ - Make sure you are logged in
- ~~Open the DevTools by pressing F12 on your keyboard~~ - Open the DevTools by pressing F12 on your keyboard
- ~~Click on the tab "Application" (On the left of the DevTools)~~ - Click on the tab "Application" (On the left of the DevTools)
- ~~Expand the "Cookies" (Under "Storage")~~ - Expand the "Cookies" (Under "Storage")
- ~~Copy the value of the "\_U" cookie~~ - Copy the value of the "\_U" cookie
## ##

18
docs/install/linux_install.md
View file

@ -18,7 +18,7 @@ Before installing ChatGPT-Clone, make sure your machine has the following prereq
## 1. Clone the repository: ## 1. Clone the repository:
```bash ```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: ## 2. Extract the content in your desired location:
@ -70,14 +70,16 @@ sudo apt-get install -y nodejs
## 7. Get your Bing Access Token ## 7. Get your Bing Access Token
Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)** ⚠️**For better results, please follow these [new instructions](https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302)**
~~Using MS Edge, navigate to bing.com~~ or
- ~~Make sure you are logged in~~
- ~~Open the DevTools by pressing F12 on your keyboard~~ Using MS Edge, navigate to bing.com
- ~~Click on the tab "Application" (On the left of the DevTools)~~ - Make sure you are logged in
- ~~Expand the "Cookies" (Under "Storage")~~ - Open the DevTools by pressing F12 on your keyboard
- ~~Copy the value of the "\_U" cookie~~ - 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 ## 8. Create the ".env" File

38
docs/install/mac_install.md
View file

@ -25,32 +25,34 @@
## Instructions: ## Instructions:
- Open Terminal and clone the repository by running git clone https://github.com/danny-avila/chatgpt-clone.git - 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 chatgpt-clone - Change into the cloned directory by running cd LibreChat
- If using MongoDB Atlas, remove &w=majority from the default connection string - If using MongoDB Atlas, remove &w=majority from the default connection string
Follow the instructions for setting up proxies, access tokens, and user system: 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) - 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. - 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. - 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**
Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)** ⚠️**For better results, please follow these [new instructions](https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302)**
~~Using MS Edge, navigate to bing.com~~ or
- ~~Make sure you are logged in~~
- ~~Open the DevTools by pressing F12 on your keyboard~~ Using MS Edge, navigate to bing.com
- ~~Click on the tab "Application" (On the left of the DevTools)~~ - Make sure you are logged in
- ~~Expand the "Cookies" (Under "Storage")~~ - Open the DevTools by pressing F12 on your keyboard
- ~~Copy the value of the "\_U" cookie~~ - 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 ## 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` - Run npm ci from root directory `npm ci`
- Build the client by running `npm run frontend` - 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. - 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: - 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 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: - 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 npm run backend
``` ```
**Make the script executable by running** ### **Make the script executable by running**
``` ```
chmod +x start_chatgpt.sh chmod +x start_chatgpt.sh
``` ```
**Start ChatGPT-Clone by running** ### **Start ChatGPT-Clone by running**
``` ```
./start_chatgpt.sh ./start_chatgpt.sh
``` ```

77
docs/install/windows_install.md
View file

@ -1,63 +1,64 @@
# Windows Install # Windows Install
### Recommended: ### Recommended: **[Docker](docker_install.md)**
### **[Docker](docker_install.md)**
or 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) (Includes a Startup and Update Utility)
## ##
## Manual Installation ## Manual Installation
### Install the prerequisites on your machine ### 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/ - 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" - 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 - 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/" - 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** - **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 - Download MeiliSearch latest release from : https://github.com/meilisearch/meilisearch/releases
- Copy it to "C:/chatgpt-clone/" - Copy it to "C:/chatgpt-clone/"
- Rename the file to "meilisearch.exe" - Rename the file to "meilisearch.exe"
- Open it by double clicking on it - Open it by double clicking on it
- Copy the generated Master Key and save it somewhere (You will need it later) - 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 - Navigate to https://www.mongodb.com/ and Sign In or Create an account
- Create a new project - Create a new project
- Build a Database using the free plan and name the cluster (example: chatgpt-clone) - Build a Database using the free plan and name the cluster (example: chatgpt-clone)
- Use the "Username and Password" method for authentication - Use the "Username and Password" method for authentication
- Add your current IP to the access list - Add your current IP to the access list
- Then in the Database Deployment tab click on Connect - Then in the Database Deployment tab click on Connect
- In "Choose a connection method" select "Connect your application" - In "Choose a connection method" select "Connect your application"
- Driver = Node.js / Version = 4.1 or later - Driver = Node.js / Version = 4.1 or later
- Copy the connection string and save it somewhere(you will need it later) - Copy the connection string and save it somewhere(you will need it later)
- **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) - 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**
Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)** ⚠️**For better results, please follow these [new instructions](https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302)**
~~Using MS Edge, navigate to bing.com~~ or
- ~~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** 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**
You will need all your credentials, (API keys, access tokens, and Mongo Connection String, MeileSearch Master Key) 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 - Open "C:/chatgpt-clone/api/.env.example" in a text editor
- At this line **MONGO_URI="mongodb://127.0.0.1:27017/chatgpt-clone"** - At this line **MONGO_URI="mongodb://127.0.0.1:27017/chatgpt-clone"**