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
- Node.js v20.19.0+ (or ^22.12.0 or >= 23.0.0): https://nodejs.org/en/download
- LibreChat uses CommonJS (CJS) and requires these specific Node.js versions for compatibility with openid-client v6
- Git: https://git-scm.com/download/
- MongoDB (Atlas or Community Server)
Installation Steps
Preparation
Run the following commands in your terminal:
Clone the Repository
git clone https://github.com/danny-avila/LibreChat.gitNavigate to the LibreChat Directory
cd LibreChatCreate a .env File from .env.example
cp .env.example .envNote: If youβre using Windows 10, you might need to use
copyinstead ofcp.
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
Build and Start
Once youβve completed the preparation steps, run the following commands:
Install dependencies
npm ciBuild the Frontend
npm run frontendStart LibreChat!
npm run backendπ
Access LibreChat!
π₯
Tip
Update LibreChat
To update LibreChat to the latest version, run the following commands:
Pull latest project changes
git pullUpdate dependencies
npm ciRebuild the Frontend
npm run frontendStart LibreChat!
npm run backendAdditional 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: