HuggingFace

Créer et configurer votre base de données (Requis)

La première chose à faire est de créer une base de données MongoDB Atlas et d'obtenir votre chaîne de connexion.

Suivez les instructions de ce document : MongoDB Atlas

Démarrage

1. Connectez-vous ou créez un compte sur Hugging Face

2. Visitez https://huggingface.co/spaces/LibreChat/template et cliquez sur Duplicate this Space pour copier le modèle LibreChat dans votre profil.

Remarque : Il est normal que ce modèle présente une erreur d'exécution ; vous devrez le configurer en suivant le guide ci-dessous pour le rendre fonctionnel.

3. Nommez votre Space et remplissez les Secrets et les Variables

Vous pouvez également décider ici de le rendre public ou privé

Vous devrez remplir ces valeurs :

⬆️ Laissez le champ de valeur vide pour tous les endpoint que vous souhaitez désactiver.

⚠️ définir les clés API et le jeton sur user_provided vous permet de les fournir en toute sécurité depuis l'interface web

• Pour CREDS_KEY, CREDS_IV et JWT_SECRET, utilisez cet outil : Générateur d'identifiants
• Exécutez l'outil une seconde fois et utilisez la nouvelle valeur JWT_SECRET pour le JWT_REFRESH_SECRET

Déploiement

1. Une fois que vous avez terminé de remplir les secrets et les variables, cliquez sur Duplicate Space en bas de cette fenêtre

2. Le projet va maintenant compiler, cela prendra quelques minutes

3. Une fois prêt, Building passera à Running

Et vous pourrez accéder à LibreChat !

Mise à jour

Pour mettre à jour LibreChat, sélectionnez simplement Factory Reboot dans le menu ⚙️Settings.

Conclusion

Vous pouvez maintenant y accéder à partir de l'URL actuelle. Si vous souhaitez y accéder sans la superposition Hugging Face, vous pouvez modifier ce modèle d'URL avec vos informations :

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

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

🎉 Félicitations, vous avez déployé avec succès LibreChat sur Hugging Face ! 🤗

Configuration de Meilisearch (Optionnel)

Pour activer la fonctionnalité de recherche dans LibreChat, vous devrez déployer et configurer une instance Meilisearch. Voici comment procéder :

1. Dupliquer l'espace Meilisearch :

Visitez ce lien : https://huggingface.co/spaces/LibreChat/meilisearch et cliquez sur "Duplicate this Space".

2. Configurez l'espace Meilisearch :

• Visibilité : Définissez la visibilité sur "public".

• MEILI_MASTER_KEY : Générez une clé maîtresse sécurisée de 16 caractères. Vous pouvez utiliser un outil comme https://randomkeygen.com/ pour générer une clé aléatoire. Définissez cette clé comme valeur pour la variable d'environnement MEILI_MASTER_KEY dans l'espace Meilisearch. Important : Gardez cette clé en sécurité !

• MEILI_ENV : Définissez la variable d'environnement MEILI_ENV sur production.

3. Dupliquer l'espace :

Cliquez sur le bouton "Duplicate Space".

4. Configurez LibreChat pour utiliser Meilisearch :

• Modifier le Dockerfile : Allez dans votre espace LibreChat (celui que vous avez dupliqué à partir du modèle LibreChat principal). Accédez à « Files » -> « Dockerfile » et cliquez sur « Edit ».

• Décommenter et modifier les lignes : Décommentez/modifiez les lignes suivantes dans le Dockerfile. Ces lignes contiendront ENV SEARCH et ENV MEILI_*. Assurez-vous de remplacer <YOUR_MEILISEARCH_SPACE_URL> par l'URL réelle de votre déploiement Meilisearch sur Hugging Face Spaces. Elle devrait ressembler à ceci : https://username-meilisearch.hf.space/. Mettez à jour le nom d'utilisateur pour qu'il corresponde au vôtre !

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

• Valider les changements : Validez vos changements sur la branche main.

5. Ajoutez le secret MEILI_MASTER_KEY à LibreChat :

• Allez dans les paramètres de votre espace LibreChat (le déploiement LibreChat, pas celui de Meilisearch).

• Cliquez sur "New secret".

• Nom : Entrez MEILI_MASTER_KEY.

• Valeur : Saisissez la même clé maîtresse que celle utilisée lors de la configuration de l'espace Meilisearch.

6. Vérifiez la configuration :

Une fois que LibreChat a été reconstruit et qu'il est en cours d'exécution, vous devriez voir une option de recherche en haut à gauche de l'interface LibreChat. Si vous ne la voyez pas, vérifiez que vous avez suivi correctement toutes les étapes.