mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-09-22 06:00:56 +02:00
fdc5265f48
* Create mkdocs.yaml * Create mkdocs.yml * Update mkdocs.yml * Update mkdocs.yml * Update mkdocs.yml * Update mkdocs.yml * Update mkdocs.yml * Update README.md * Update coding_conventions.md * Update documentation_guidelines.md * Update testing.md * Update heroku.md * Update hetzner_ubuntu.md * Update google_search.md * Update introduction.md * Update make_your_own.md * Update stable_diffusion.md * Update wolfram.md * Update proxy.md * Update user_auth_system.md * Update bing_jailbreak_info.md * Update breaking_changes.md * Update multilingual_information.md * Update project_origin.md * Update tech_stack.md * Update apis_and_tokens.md * Update docker_install.md * Update linux_install.md * Update mac_install.md * Update windows_install.md * Update mkdocs.yml * Update mkdocs.yml * Update documentation_guidelines.md * Add files via upload * Create temp.txt * Add files via upload * Delete logo.png * Create index.md * Update mkdocs.yml * Update mkdocs.yml * Delete temp.txt * Update README.md * Update README.md --------- Co-authored-by: Danny Avila <110412045+danny-avila@users.noreply.github.com>
3.8 KiB
3.8 KiB
Linux Installation
Recommended: Docker Install
Manual Installation:
Prerequisites
Before installing LibreChat, 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.
Clone the repository:
git clone https://github.com/danny-avila/LibreChat.git
Extract the content in your desired location:
cd LibreChat
unzip LibreChat.zip -d /usr/local/
Note: The above command extracts the files to "/usr/local/LibreChat". If you want to install the files to a different location, modify the instructions accordingly.
Enable the Conversation search feature: (optional)
- Download MeiliSearch latest release from: https://github.com/meilisearch/meilisearch/releases
- Copy it to "/usr/local/LibreChat/"
- Rename the file to "meilisearch"
- Open a terminal and navigate to "/usr/local/LibreChat/"
- Run the following command:
./meilisearch --master-key=YOUR_MASTER_KEY
Note: Replace "YOUR_MASTER_KEY" with the generated master key, which you saved earlier.
Install Node.js:
Open a terminal and run the following commands:
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs
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).
Get Your API keys and Tokens (Required)
- You must set up at least one of these tokens or APIs to run the app.
User/Auth System (Optional)
- How to set up the user/auth system and Google login.
Run the project
Using the command line (in the root directory)
Setup the app:
- Run
npm ci - Run
npm run frontend
Start the app:
- Run
npm run backend - Run
meilisearch --master-key put_your_meilesearch_Master_Key_here(Only if SEARCH=TRUE) - 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/LibreChat/LibreChat.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 LibreChat 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="LibreChat" --working-directory=/home/user/LibreChat/ --command="bash -c 'npm run backend'"
# this shell script goes at the root of the LibreChat directory (/home/user/LibreChat/)
Update the app version
If you update the LibreChat project files, manually redo the npm ci and npm run frontend steps.