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/danny-avila/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/danny-avila/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

2. Create and Configure .env File:

   • Copy the contents of .env.example to a new file named .env.
   • Fill in any necessary values.
     • For an in-depth environment configuration, see the .env File Configuration Guide.

3. Start the Application:

   • Run the following command:

   docker compose up

Conclusion

That’s it! You should now have LibreChat running locally on your machine. Enjoy!

Additional Links

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

• Updating LibreChat
  • Instructions on how to update this setup with the latest changes to LibreChat.
• Configuring AI Providers
  • Configure OpenAI, Google, Anthropic, and OpenAI Assistants
• Configuring a Custom Endpoint
  • Configure services such as OpenRouter, Ollama, Mistral AI, Databricks, groq, and others.
  • Click here for a list of known, compatible services.
• Environment Configuration
  • Read for a comprehensive look at the .env file.
• librechat.yaml File Configuration
  • Configure custom rate limiters, file outputs, and much more with the librechat.yaml file.
• Ubuntu Docker Deployment Guide
  • Read for advanced Docker setup on a remote/headless server.
• Setup the Azure OpenAI endpoint
  • Configure multiple Azure regions and deployments for seamless use with LibreChat.