Files | Manual | Links

LibreChat Installation Guide

LibreChat Installation Docker linux Guide

Install from User not root

cd /home/user/

Disk space (3 GB system, 8 GB for LibreChat).

Official manual https://www.librechat.ai/docs/remote/docker_linux

Step 1 install Docker

sudo apt update
sudo apt install apt-transport-https ca-certificates curl software-properties-common gnupg lsb-release
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt update
sudo apt install docker-ce -y
sudo usermod -aG docker $USER
sudo reboot
sudo systemctl status docker
sudo curl -L https://github.com/docker/compose/releases/download/v2.26.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo apt install git nodejs npm
git --version
node -v
npm -v
    

Step 2 install LibreChat

# clone down the repository
git clone https://github.com/danny-avila/LibreChat.git
# enter the project directory
cd LibreChat/
    

Step 3 Startup config librechat. Here is config. Gray icons AI Providers list #1 config on web.

cp .env.example .env

    #CONFIG_PATH="/alternative/path/to/librechat.yaml" .env only variant. Optional is can add in see next docker-compose.override.yml
    #GROQ_API_KEY=  #Set api key in config
    GROQ_API_KEY=user_provided  #Edit api key from browser
    ALLOW_REGISTRATION=true
    Change keys with generator https://www.librechat.ai/toolkit/creds_generator
    or openssl rand -hex 16 # for CREDS_IV && openssl rand -hex 32 # for CREDS_KEY, JWT_SECRET, JWT_REFRESH_SECRET
    ~# openssl rand -hex 16 && openssl rand -hex 32 && openssl rand -hex 32 && openssl rand -hex 32
        CREDS_IV:
        CREDS_KEY:
        JWT_SECRET:
        JWT_REFRESH_SECRET:
    uncoment:
    UID=1000
    GID=1000
    

Step 4 Enable librechat.yaml Color icons AI Providers config on web.

cp docker-compose.override.yml.example docker-compose.override.yml

services:
  api:
    volumes:
      - ./librechat.yaml:/app/librechat.yaml

cp librechat.example.yaml librechat.yaml
Providers list and mcp #2
Valid check ~#yamllint librechat.yaml

  custom:
    # Groq Example
    - name: 'groq'
      #apiKey: '${GROQ_API_KEY}'
      ....
    # mcpServers:
    #   everything:
      ....
    

Step 5 Run

sudo docker-compose -f ./deploy-compose.yml up -d
Or ~# npm run start:deployed
Rebuild
sudo docker-compose -f ./deploy-compose.yml up -d --build

Logs:
docker logs -f LibreChat-API

Restart bash
restart.sh
sudo docker-compose -f ./deploy-compose.yml down
sudo docker-compose -f ./deploy-compose.yml up -d
    

Step 6 ERR

getaddrinfo EAI_AGAIN mongodb
Change CPU to host if use VM

Logout after page refresh
Need HTTPS