Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Visão geral

Como os arquivos de configuração do LibreChat funcionam em conjunto e como aplicar alterações

O LibreChat utiliza quatro arquivos de configuração principais. Cada um controla um aspecto diferente da aplicação -- desde variáveis de ambiente até endpoints de IA personalizados e substituições de serviço Docker.

Fluxo de Trabalho de Alteração Comum

A maioria das alterações de configuração segue o mesmo padrão:

  1. Edite o .env para segredos, chaves de API e sinalizadores de recursos em nível de servidor.
  2. Edite o librechat.yaml para endpoints personalizados, Model Specs, configurações de interface, servidores MCP, agentes e comportamento avançado do aplicativo.
  3. Para Docker, certifique-se de que o librechat.yaml esteja montado através do docker-compose.override.yml antes de esperar que o LibreChat o leia.
  4. Reinicie o LibreChat após cada alteração de configuração.
  5. Verifique os logs da API se a alteração não aparecer na UI.

Por exemplo, para habilitar o OpenRouter, você adiciona OPENROUTER_KEY ao .env, adiciona um endpoint do OpenRouter no librechat.yaml, certifica-se de que o Docker monte o librechat.yaml, reinicia e, em seguida, seleciona o OpenRouter no seletor de endpoint.

Arquivos de Configuração

.env
librechat.yaml
docker-compose.yml
docker-compose.override.yml

.env -- Configurações em nível de servidor: chaves de API, strings de conexão com banco de dados, sinalizadores de recursos (feature flags) e segredos de autenticação. Este é o arquivo de configuração principal para a maioria das implantações. Veja a referência do .env para todas as variáveis disponíveis.

librechat.yaml -- Endpoints de IA personalizados, configurações de modelo, opções de interface e recursos avançados como servidores MCP e agentes. Este arquivo é opcional -- o LibreChat funciona com padrões caso ele não exista. Veja o guia do librechat.yaml para instruções de configuração.

docker-compose.yml -- Define os serviços Docker (servidor API, banco de dados, busca). Não edite este arquivo diretamente -- use um arquivo de substituição (override) para que suas alterações sobrevivam às atualizações.

docker-compose.override.yml -- Suas personalizações locais para serviços Docker: montagens de volume, mapeamentos de porta, substituições de variáveis de ambiente. O Docker Compose mescla isso com o arquivo principal automaticamente. Veja o guia de override do Docker.

Aplicando Alterações

Reinicialização necessária

Após editar qualquer arquivo de configuração, você deve reiniciar o LibreChat para que as alterações entrem em vigor.

docker compose down && docker compose up -d

Interrompa o processo em execução (Ctrl+C) e reinicie:

npm run backend

Próximos Passos

Como está este guia?