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 18+: https://nodejs.org/en/download
- 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.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 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 ci
Build the Frontend
npm run frontend
Start 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 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: