Skip to main content

LibreChat is joining ClickHouse. Learn more

LibreChat

Local Setup Guide

This is a condensed version of our Local Installation Guide

Step 1. Download the Project

Manual Download

  1. Go to the Project Page: Visit https://github.com/LibreChat-AI/LibreChat.

  2. Download the ZIP File: Click the green "Code" button, then click "Download ZIP."

  3. Extract the ZIP File: Find the downloaded ZIP file, right-click, and select "Extract All...".

Using Git

Run the following git command in your terminal, from the desired parent directory:

git clone https://github.com/LibreChat-AI/LibreChat.git

Step 2. Install Docker

  1. Download: Go to Docker Desktop Download Page and download Docker Desktop.
  2. Install: Open the installer and follow the instructions.
  3. Run: Open Docker Desktop to ensure it is running.

Notes:

  • Docker Desktop is recommended for most users. If you are looking for an advanced docker/container setup, especially for a remote server installation, see our Ubuntu Docker Deployment Guide.
  • You may need to restart your computer after installation.

Step 3. Run the App

  1. Navigate to the Project Directory: Open a terminal in the LibreChat folder you cloned or extracted in Step 1. If you used Git:

    cd LibreChat
  2. Create the .env File: Copy .env.example to a new file named .env:

    cp .env.example .env

    On Windows, use copy .env.example .env if cp is not available.

    The default values work out of the box for a basic local setup. For in-depth environment configuration, see the .env File Configuration Guide.

  3. Start the Application: Make sure Docker Desktop is running, then run:

    docker compose up -d

    The first launch downloads the Docker images and may take a few minutes. Subsequent starts are much faster. If a container stops right after starting, see the Docker guide troubleshooting section.

Step 4. Start Chatting

LibreChat is now running, but it needs an account and a model before it can answer anything:

  1. Open http://localhost:3080 in your browser.
  2. Register an account on the login page.
  3. Add an API key for the provider you want to use.

Follow Your First Chat for these steps in detail, including what to do when no model answers.


Additional Links

Explore more about LibreChat and how to configure it to your needs.

How is this guide?