Hugging Face's logo

Spaces:
farhananis005
/
ChatGPT
Sleeping

App Files Community
ChatGPT / docs /install /windows_install.md
Marco Beretta
LibreChat upload repo
3b6afc0
preview code
|
raw
history blame
4.34 kB

Windows Installation Guide

Recommended:

Watch the video 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:
  • 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

(Includes a Startup and Update Utility)

Manual Installation

Install the prerequisites on your machine

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"
  • 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:/LibreChat/"
  • 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:/LibreChat/"
  • 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 (Required)

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.

Setup and Run 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:

  1. Run npm run backend
  2. Run meilisearch --master-key <meilisearch_Master_Key> (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 LibreChat directory
    • Put your MeiliSearch master key instead of "<meilisearch_Master_Key>"
    • Save the file as "C:/LibreChat/LibreChat.bat"
    • you can make a shortcut of this batch file and put it anywhere
    start "MeiliSearch" cmd /k "meilisearch --master-key <meilisearch_Master_Key>

start "LibreChat" cmd /k "npm run backend"

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

Note: If you're still having trouble, before creating a new issue, please search for similar ones on our #issues thread on our discord or our troubleshooting discussion 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.