HuggingFace

Crie e configure seu banco de dados (Obrigatório)

A primeira coisa que você precisa é criar um MongoDB Atlas Database e obter sua string de conexão.

Siga as instruções neste documento: MongoDB Atlas

Primeiros Passos

1. Faça login ou crie uma conta no Hugging Face

2. Visite https://huggingface.co/spaces/LibreChat/template e clique em Duplicate this Space para copiar o template do LibreChat para o seu perfil.

Nota: É normal que este modelo apresente um erro de tempo de execução; você precisará configurá-lo usando o guia a seguir para torná-lo funcional.

3. Nomeie seu Space e preencha os Secrets e Variables

Você também pode decidir aqui se deseja torná-lo público ou privado

Você precisará preencher estes valores:

⬆️ Deixe o campo de valor em branco para quaisquer endpoints que você deseje desativar.

⚠️ definir as chaves de API e o token como user_provided permite que você os forneça com segurança a partir da webUI

• Para CREDS_KEY, CREDS_IV e JWT_SECRET use esta ferramenta: Credentials Generator
• Execute a ferramenta uma segunda vez e use o novo valor de JWT_SECRET para o JWT_REFRESH_SECRET

Implantação

1. Quando terminar de preencher os secrets e variables, clique em Duplicate Space na parte inferior dessa janela

2. O projeto irá compilar agora, isso levará alguns minutos

3. Quando estiver pronto, Building mudará para Running

E você poderá acessar o LibreChat!

Atualização

Para atualizar o LibreChat, basta selecionar Factory Reboot no menu de ⚙️Settings.

Conclusão

Agora você pode acessá-lo a partir da URL atual. Se você quiser acessá-lo sem a sobreposição do Hugging Face, você pode modificar este modelo de URL com suas informações:

https://username-projectname.hf.space/

p. ex. https://cooluser-librechat.hf.space/

🎉 Parabéns, você implantou o LibreChat com sucesso no Hugging Face! 🤗

Configuração do Meilisearch (Opcional)

Para habilitar a funcionalidade de busca no LibreChat, você precisará implantar e configurar uma instância do Meilisearch. Veja como:

1. Duplique o Space do Meilisearch:

Visite este link: https://huggingface.co/spaces/LibreChat/meilisearch e clique em "Duplicate this Space".

2. Configure o espaço do Meilisearch:

• Visibilidade: Defina a visibilidade como "public".

• MEILI_MASTER_KEY: Gere uma chave mestra segura de 16 caracteres. Você pode usar uma ferramenta como https://randomkeygen.com/ para gerar uma chave aleatória. Defina esta chave como o valor para a variável de ambiente MEILI_MASTER_KEY no espaço do Meilisearch. Importante: Mantenha esta chave segura!

• MEILI_ENV: Defina a variável de ambiente MEILI_ENV como production.

3. Duplique o Space:

Clique no botão "Duplicate Space".

4. Configure o LibreChat para usar o Meilisearch:

• Edite o Dockerfile: Vá para o seu espaço LibreChat (aquele que você duplicou do template principal do LibreChat). Navegue até "Files" -> "Dockerfile" e clique em "Edit".

• Descomente e Modifique as Linhas: Descomente/edite as seguintes linhas no Dockerfile. Estas linhas conterão ENV SEARCH e ENV MEILI_*. Certifique-se de substituir <YOUR_MEILISEARCH_SPACE_URL> pela URL real da sua implementação do Meilisearch no Hugging Face Spaces. Ela deve ser algo como https://<your-username>-meilisearch.hf.space/. Atualize o nome de usuário para corresponder ao seu nome de usuário!

  ENV SEARCH=true
  ENV MEILI_NO_ANALYTICS=true
  ENV MEILI_HOST=<YOUR_MEILISEARCH_SPACE_URL>

• Commit Changes: Faça o commit das suas alterações na branch main.

5. Adicione o segredo MEILI_MASTER_KEY ao LibreChat:

• Vá para as configurações do seu espaço LibreChat (a implantação do LibreChat, não a do Meilisearch).

• Clique em "New secret".

• Nome: Insira MEILI_MASTER_KEY.

• Valor: Insira a mesma chave mestra que você usou ao configurar o espaço do Meilisearch.

6. Verifique a Configuração:

Após o LibreChat reconstruir e começar a rodar, você deverá ver uma opção de pesquisa no canto superior esquerdo da interface do LibreChat. Se você não a vir, verifique novamente se seguiu todos os passos corretamente.