mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-01-25 11:46:12 +01:00
update: "documents" folder to "docs" (#391)
* Rename .github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md to .github/pull_request_template.md fix: Pull Request Template Location * documents -> docs * Update windows_install.md Fix: Docker hyperlink * Update linux_install.md Fix: Layout (step 6) * Rename docs/contributions/code_of_conduct.md to CODE_OF_CONDUCT.md fix: Code of Conduct location according to GitHub's Guide * Update CODE_OF_CONDUCT.md Update: Contact info * Update README.md Update: Code of Conduct hyperlink in TOC * Update CODE_OF_CONDUCT.md Update: Link to ReadMe * Update CONTRIBUTORS.md update: add new name to the list * Update and rename docs/contributions/contributor_guidelines.md to CONTRIBUTING.md fix: change location according to GitHub's standards * Delete CONTRIBUTORS.md delete: contributor.md from root (already present in readme) * Update SECURITY.md * Update CONTRIBUTING.md Update discord link to point to rules * Update README.md Update discord link to point to rules * Update README.md fix: ToC
This commit is contained in:
Fuegovic
GitHub
parent
f40a2f8ee8
commit
d437e4b8cd
26 changed files with 34 additions and 57 deletions
67
docs/install/docker_install.md
Normal file
67
docs/install/docker_install.md
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
# Docker
|
||||
|
||||
|
||||
|
||||
- **Edit** the credentials you see in [docker-compose.yml](https://stackedit.io/docker-compose.yml) under api service as needed
|
||||
- **Provide** all necessary credentials in the ./api/.env and client/.env files before the next step
|
||||
- Docker will read those env files. See their respective `.env.example` files for reference
|
||||
- **Run** `docker-compose up` to start the app
|
||||
- Note: MongoDB does not support older ARM CPUs like those found in Raspberry Pis. However, you can make it work by setting MongoDB’s version to mongo:4.4.18 in docker-compose.yml, the most recent version compatible with
|
||||
|
||||
##
|
||||
|
||||
**[chatgptclone/app Tags | Docker Hub](https://hub.docker.com/r/chatgptclone/app/tags)**
|
||||
|
||||
##
|
||||
|
||||
### Prerequisites
|
||||
- Node.js >= 19.0.0 : https://nodejs.org/en/download
|
||||
- MongoDB installed or [MongoDB Atlas](https://account.mongodb.com/account/login) (required if not using Docker)
|
||||
- MongoDB does not support older ARM CPUs like those found in Raspberry Pis. However, you can make it work by setting MongoDB's version to mongo:4.4.18 in docker-compose.yml, the most recent version compatible with.
|
||||
- If using MongoDB Atlas, remove `&w=majority` from default connection string.
|
||||
- [OpenAI API key](https://platform.openai.com/account/api-keys)
|
||||
- BingAI, ChatGPT access tokens (optional, free AIs)
|
||||
|
||||
### Usage
|
||||
|
||||
- **Clone/download** the repo down where desired
|
||||
```bash
|
||||
git clone https://github.com/danny-avila/chatgpt-clone.git
|
||||
```
|
||||
##
|
||||
|
||||
**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
|
||||
- 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.
|
||||
|
||||
|
||||
##
|
||||
**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**
|
||||
|
||||
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~~
|
||||
|
||||
##
|
||||
|
||||
## [Go Back to ReadMe](../../README.md)
|
||||
134
docs/install/linux_install.md
Normal file
134
docs/install/linux_install.md
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
# Linux Installation
|
||||
## **Recommended : [Docker Install](docker_install.md)**
|
||||
|
||||
##
|
||||
|
||||
## **Manual Installation**
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before installing ChatGPT-Clone, make sure your machine has the following prerequisites installed:
|
||||
|
||||
- Git: To clone the repository.
|
||||
- Node.js: To run the application.
|
||||
- MongoDB: To store the chat history.
|
||||
|
||||
## Installation Steps
|
||||
|
||||
## 1. Clone the repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/danny-avila/chatgpt-clone.git
|
||||
```
|
||||
|
||||
## 2. Extract the content in your desired location:
|
||||
|
||||
```bash
|
||||
cd chatgpt-clone
|
||||
unzip chatgpt-clone.zip -d /usr/local/
|
||||
```
|
||||
|
||||
Note: The above command extracts the files to "/usr/local/chatgpt-clone". If you want to install the files to a different location, modify the instructions accordingly.
|
||||
|
||||
## 3. Enable the Conversation search feature: (optional)
|
||||
|
||||
- Download MeiliSearch latest release from: https://github.com/meilisearch/meilisearch/releases
|
||||
- Copy it to "/usr/local/chatgpt-clone/"
|
||||
- Rename the file to "meilisearch"
|
||||
- Open a terminal and navigate to "/usr/local/chatgpt-clone/"
|
||||
- Run the following command:
|
||||
|
||||
```bash
|
||||
./meilisearch --master-key=YOUR_MASTER_KEY
|
||||
```
|
||||
|
||||
Note: Replace "YOUR_MASTER_KEY" with the generated master key, which you saved earlier.
|
||||
|
||||
## 4. Install Node.js:
|
||||
|
||||
Open a terminal and run the following commands:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
|
||||
sudo apt-get install -y nodejs
|
||||
```
|
||||
|
||||
## 5. 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).
|
||||
|
||||
## 6. Get your OpenAI API key
|
||||
- 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
|
||||
|
||||
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~~
|
||||
|
||||
## 8. Create the ".env" File
|
||||
|
||||
You will need all your credentials, (API keys, access tokens, and MongoDB Connection String, MeiliSearch Master Key)
|
||||
|
||||
- Open "~/chatgpt-clone/api/.env.example" in a text editor
|
||||
- At this line MONGO_URI="mongodb://127.0.0.1:27017/chatgpt-clone", replace mongodb://127.0.0.1:27017/chatgpt-clone with the MongoDB connection string you saved earlier, remove "&w=majority" at the end
|
||||
- It should look something like this: "MONGO_URI="mongodb+srv://username:password@chatgpt-clone.lfbcwz3.mongodb.net/?retryWrites=true"
|
||||
- At this line OPENAI_KEY= you need to add your OpenAI API key
|
||||
- Add your Bing token to this line BINGAI_TOKEN= (needed for BingChat & Sydney)
|
||||
- If you want to enable Search, SEARCH=TRUE if you do not want to enable search SEARCH=FALSE
|
||||
- Add your previously saved MeiliSearch Master key to this line MEILI_MASTER_KEY= (the key is needed if search is enabled even on local install or you may encounter errors)
|
||||
- Save the file as "~/chatgpt-clone/api/.env"
|
||||
|
||||
## Run the project
|
||||
|
||||
### Using the command line (in the root directory)
|
||||
Setup the app:
|
||||
1. Run `npm ci`
|
||||
2. Run `npm run frontend`
|
||||
|
||||
## Start the app:
|
||||
1. Run `npm run backend`
|
||||
2. Run `meilisearch --master-key put_your_meilesearch_Master_Key_here` (Only if SEARCH=TRUE)
|
||||
3. Visit http://localhost:3080 (default port) & enjoy
|
||||
|
||||
### Using a shell script
|
||||
|
||||
- Create a shell script to automate the starting process
|
||||
- Open a text editor
|
||||
- Paste the following code in a new document
|
||||
- Put your MeiliSearch master key instead of "your_master_key_goes_here"
|
||||
- Save the file as "/home/user/chatgpt-clone/chatgpt-clone.sh"
|
||||
- You can make a shortcut of this shell script and put it anywhere
|
||||
|
||||
```
|
||||
#!/bin/bash
|
||||
# the meilisearch executable needs to be at the root of the chatgpt-clone directory
|
||||
|
||||
gnome-terminal --tab --title="MeiliSearch" --command="bash -c 'meilisearch --master-key your_master_key_goes_here'"
|
||||
# ↑↑↑ meilisearch is the name of the meilisearch executable, put your own master key there
|
||||
|
||||
gnome-terminal --tab --title="ChatGPT-Clone" --working-directory=/home/user/chatgpt-clone/ --command="bash -c 'npm run backend'"
|
||||
# this shell script goes at the root of the chatgpt-clone directory (/home/user/chatgpt-clone/)
|
||||
```
|
||||
|
||||
## Update the app version
|
||||
|
||||
If you update the chatgpt-clone project files, manually redo the npm ci and npm run frontend steps.
|
||||
|
||||
##
|
||||
|
||||
|
||||
## [Go Back to ReadMe](../../README.md)
|
||||
124
docs/install/mac_install.md
Normal file
124
docs/install/mac_install.md
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
# Mac Install
|
||||
## **Recommended : [Docker Install](docker_install.md)**
|
||||
|
||||
##
|
||||
|
||||
## **Manual Installation**
|
||||
|
||||
## Install the prerequisites:
|
||||
- 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: 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)
|
||||
|
||||
|
||||
## 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
|
||||
- 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:
|
||||
|
||||
**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:**
|
||||
|
||||
- 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**
|
||||
|
||||
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~~
|
||||
|
||||
|
||||
## Setup Instruction
|
||||
- Create a .env file in the api directory by running cp api/.env.example api/.env and edit the file with your preferred text editor, adding the required API keys, access tokens, and MongoDB connection string
|
||||
- Run npm ci from root directory `npm ci`
|
||||
- Build the client by running `npm run frontend`
|
||||
|
||||
**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:**
|
||||
- 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:**
|
||||
- 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:
|
||||
|
||||
```
|
||||
./meilisearch-macos-amd64 --master-key your_master_key_goes_here
|
||||
```
|
||||
|
||||
- MeiliSearch will start running on the default port, which is 7700. You can now use MeiliSearch in your ChatGPT-Clone project.
|
||||
|
||||
- Remember to include the MeiliSearch URL and Master Key in your .env file in the api directory. Your .env file should include the following lines:
|
||||
|
||||
```
|
||||
MEILISEARCH_URL=http://127.0.0.1:7700
|
||||
MEILISEARCH_KEY=your_master_key_goes_here
|
||||
```
|
||||
|
||||
- With MeiliSearch running and configured, the ChatGPT-Clone project should now have the Conversation search feature enabled.
|
||||
|
||||
- In the chatgpt-clone directory, start the application by running `npm run backend`
|
||||
Visit http://localhost:3080 (default port) & enjoy
|
||||
|
||||
## Optional but recommended:
|
||||
|
||||
- Create a script to automate the starting process by creating a new file named start_chatgpt.sh in the chatgpt-clone directory and pasting the following code:
|
||||
|
||||
```
|
||||
#!/bin/bash
|
||||
# Replace "your_master_key_goes_here" with your MeiliSearch Master Key
|
||||
if [ -x "$(command -v ./meilisearch)" ]; then
|
||||
./meilisearch --master-key your_master_key_goes_here &
|
||||
fi
|
||||
npm run backend
|
||||
```
|
||||
|
||||
**Make the script executable by running**
|
||||
|
||||
```
|
||||
chmod +x start_chatgpt.sh
|
||||
```
|
||||
|
||||
**Start ChatGPT-Clone by running**
|
||||
```
|
||||
./start_chatgpt.sh
|
||||
```
|
||||
|
||||
|
||||
## **Update**
|
||||
- run `git pull` from the root dir
|
||||
- Run npm ci from root directory `npm ci`
|
||||
- Build the client by running `npm run frontend`
|
||||
|
||||
##
|
||||
|
||||
## [Go Back to ReadMe](../../README.md)
|
||||
110
docs/install/windows_install.md
Normal file
110
docs/install/windows_install.md
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
# Windows Install
|
||||
|
||||
### Recommended:
|
||||
### **[Docker](docker_install.md)**
|
||||
or
|
||||
### **[Automated Installer (Windows)](https://github.com/fuegovic/chatgpt-clone-local-installer)**
|
||||
(Includes a Startup and Update Utility)
|
||||
##
|
||||
|
||||
## Manual Installation
|
||||
### Install the prerequisites on your machine
|
||||
|
||||
- **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**
|
||||
|
||||
- **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 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**
|
||||
|
||||
- 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 Bing Access Token**
|
||||
|
||||
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~~
|
||||
|
||||
- **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"**
|
||||
Replace mongodb://127.0.0.1:27017/chatgpt-clone with the MondoDB connection string you saved earlier, **remove "&w=majority" at the end**
|
||||
- It should look something like this: "MONGO_URI="mongodb+srv://username:password@chatgpt-clone.lfbcwz3.mongodb.net/?retryWrites=true"
|
||||
- At this line **OPENAI_KEY=** you need to add your openai API key
|
||||
- Add your Bing token to this line **BINGAI_TOKEN=** (needed for BingChat & Sydney)
|
||||
- If you want to enable Search, **SEARCH=TRUE** if you do not want to enable search **SEARCH=FALSE**
|
||||
- Add your previously saved MeiliSearch Master key to this line **MEILI_MASTER_KEY=** (the key is needed if search is enabled even on local install or you may encounter errors)
|
||||
- Save the file as **"C:/chatgpt-clone/api/.env"**
|
||||
|
||||
### Run the app
|
||||
|
||||
### Using the command line (in the root directory)
|
||||
To setup the app:
|
||||
1. Run `npm ci`
|
||||
2. Run `npm run frontend`
|
||||
|
||||
To use the app:
|
||||
1. Run `npm run backend`
|
||||
2. Run `meilisearch --master-key put_your_meilesearch_Master_Key_here` (Only if SEARCH=TRUE)
|
||||
3. Visit http://localhost:3080 (default port) & enjoy
|
||||
|
||||
#### Using a batch file
|
||||
|
||||
- **Make a batch file to automate the starting process**
|
||||
- Open a text editor
|
||||
- Paste the following code in a new document
|
||||
- The meilisearch executable needs to be at the root of the chatgpt-clone directory
|
||||
- Put your MeiliSearch master key instead of "your_master_key_goes_here"
|
||||
- Save the file as "C:/chatgpt-clone/chatgpt-clone.bat"
|
||||
- you can make a shortcut of this batch file and put it anywhere
|
||||
|
||||
```
|
||||
start "MeiliSearch" cmd /k "meilisearch --master-key your_master_key_goes_here
|
||||
|
||||
start "ChatGPT-Clone" cmd /k "npm run backend"
|
||||
|
||||
REM this batch file goes at the root of the chatgpt-clone directory (C:/chatgpt-clone/)
|
||||
```
|
||||
|
||||
### **Update**
|
||||
- run `git pull` from the root dir
|
||||
- Run npm ci from root directory `npm ci`
|
||||
- Build the client by running `npm run frontend`
|
||||
|
||||
|
||||
##
|
||||
|
||||
## [Go Back to ReadMe](../../README.md)
|
||||
Loading…
Add table
Add a link
Reference in a new issue