Docker

Para a maioria dos cenários, o Docker Compose é o método de instalação recomendado devido à sua simplicidade, facilidade de uso e confiabilidade.

Pré-requisitos

• Git
• Docker

O Docker Desktop é recomendado para a maioria dos usuários. Para instalações em servidores remotos, consulte o Guia de Implantação do Docker no Ubuntu.

services:
  mongodb:
    image: mongo:4.4.18

Instalação

git clone https://github.com/danny-avila/LibreChat.git
cd LibreChat

cp .env.example .env

docker compose up -d

Montando o librechat.yaml

Para usar um arquivo de configuração librechat.yaml personalizado com Docker, você precisa montá-lo como um volume para que o container possa acessá-lo.

Copie o arquivo de exemplo de substituição (override) e edite-o:

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

Certifique-se de que a montagem de volume do librechat.yaml esteja descomentada em docker-compose.override.yml:

services:
  api:
    volumes:
      - type: bind
        source: ./librechat.yaml
        target: /app/librechat.yaml

Reinicie para que as alterações entrem em vigor:

docker compose down && docker compose up -d

Para instruções completas de configuração, incluindo a criação do arquivo do zero, consulte o guia do librechat.yaml. Para mais opções de substituição, consulte o guia de substituição do Docker.

Atualizando o LibreChat

Os comandos a seguir buscarão as alterações mais recentes do projeto LibreChat, incluindo quaisquer mudanças necessárias nos arquivos docker compose, bem como as imagens pré-compiladas mais recentes.

docker compose down

# Linux/Mac
docker images -a | grep "librechat" | awk '{print $3}' | xargs docker rmi

# Windows (PowerShell)
docker images -a --filter "reference=registry.librechat.ai/danny-avila/librechat*" --format "{{.ID}}" | ForEach-Object { docker rmi $_ }
docker images -a --filter "reference=ghcr.io/danny-avila/librechat*" --format "{{.ID}}" | ForEach-Object { docker rmi $_ }

git pull

docker compose pull

docker compose up

Solução de problemas

Porta Já em Uso

Se você vir um erro como bind: address already in use para a porta 3080, outro aplicativo está usando essa porta.

Ou interrompa o aplicativo em conflito, ou altere a porta no docker-compose.override.yml:

services:
  api:
    ports:
      - "3081:3080"

Então visite http://localhost:3081 em vez disso.

O container trava na inicialização

Se os containers encerrarem imediatamente após a inicialização, verifique os logs:

docker compose logs api

Causas comuns:

• Sintaxe do librechat.yaml inválida -- valide com o YAML Validator
• Arquivo .env ausente -- certifique-se de que o .env exista na raiz do projeto
• Docker não está em execução -- certifique-se de que o Docker Desktop esteja aberto e em execução

Variáveis de Ambiente Ausentes

Se os recursos não estiverem funcionando como esperado, verifique se as variáveis de ambiente necessárias estão definidas no seu .env file.

docker compose exec api env | grep -i "your_variable"

Veja a referência do .env para todas as variáveis disponíveis e seus valores padrão.

Próximos Passos