Docs
Local Installation
npm

Install LibreChat Locally Using npm

For most scenarios, Docker Compose is the recommended installation method due to its simplicity, ease of use, and reliability. If you prefer using npm, you can follow these instructions.

Prerequisites

Installation Steps

Preparation

Run the following commands in your terminal:

Clone the Repository
git clone https://github.com/danny-avila/LibreChat.git
Navigate to the LibreChat Directory
cd LibreChat
Create a .env File from .env.example
cp .env.example .env

Note: If you’re using Windows 10, you might need to use copy instead of cp.

Update the MONGO_URI
Important: Edit the newly created `.env` file to update the `MONGO_URI` with your own MongoDB instance URI.
Update the MONGO_URI

Edit the newly created .env file to update the MONGO_URI with your own

Build and Start

Once you’ve completed the preparation steps, run the following commands:

Install dependencies
npm ci
Build the Frontend
npm run frontend
Start LibreChat!
npm run backend
🎉
Access LibreChat!
🔥
Tip
  • Next time you want to start LibreChat, you only need to execute npm run backend

Update LibreChat

To update LibreChat to the latest version, run the following commands:

First, stop LibreChat (if you haven’t already).

Pull latest project changes
git pull
Update dependencies
npm ci
Rebuild the Frontend
npm run frontend
Start LibreChat!
npm run backend

Additional Setup

Unlock additional features by exploring our configuration guides to learn how to set up:

  • Meilisearch integration
  • RAG API connectivity
  • Custom endpoints
  • Other advanced configuration options
  • And more

This will enable you to customize your LibreChat experience with optional features.

see also: