Installation

Prérequis

Pour garantir le bon fonctionnement de Hexabot, vous aurez besoin des éléments suivants :

• Docker : Nous recommandons d'utiliser Docker pour démarrer l'application car plusieurs services sont requis (MongoDB, Nginx, etc.). Tous les fichiers Docker Compose nécessaires se trouvent dans le dossier docker dossier.

Configurer Docker pour le développement et la production

• Node.js : Pour le développement, assurez-vous d'avoir Node.js >= v18.17.0 installé. Nous recommandons d'utiliser nvm (Node Version Manager) pour gérer et mettre à jour facilement vos versions de Node.js.

Configurer Node.js avec NVM

Voulez-vous installer Hexabot sur une machine Windows ?

1. Téléchargez et installez Docker Desktop pour Windows.

2. Pendant l'installation, assurez-vous de sélectionner l'option d'utiliser WSL 2 comme backend par défaut pour Docker.

3. Après l'installation, lancez Docker Desktop et vérifiez que l'intégration WSL est activée :

4. Ouvrez Docker Desktop et allez dans Paramètres. Sous l'onglet Général, assurez-vous que « Utiliser le moteur basé sur WSL 2 » est sélectionné. Sous Ressources > Intégration WSL, activez l'intégration avec votre distribution Linux installée (par exemple, Ubuntu). Redémarrez votre machine pour finaliser l'installation de Docker.

5. Ouvrez votre terminal WSL (par exemple, Ubuntu).

6. Suivez Hexabot installation étapes ci-dessous

En savoir plus : https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers

Installation

1. Installez Hexabot CLI globalement pour avoir un accès facile à ses commandes :

npm install -g hexabot-cli

1. Créer un nouveau projet:

hexabot create my-chatbot

1. Accédez à votre dossier de projet

cd my-chatbot/

1. Installer les dépendances:

npm i

1. Configuration de l'environnement :

Pour configurer les variables d'environnement, utilisez la commande suivante :

hexabot init

Ceci va copier le .env.example fichier vers .env dans le ./docker répertoire si le fichier n'existe pas déjà.

Vous pouvez en savoir plus sur la commande Hexabot CLI ici.

1. Exécuter en mode développement : Une fois votre environnement configuré, vous pouvez démarrer l'application. Utilisez la commande suivante :

hexabot dev --services ollama

Remarquez que nous avons ajouté un service supplémentaire appelé Ollama. Ollama facilite le démarrage et l'utilisation locale des grands modèles de langage. Assurez-vous de vous connecter en SSH dans le conteneur et de télécharger le(s) modèle(s) que vous souhaitez utiliser :

docker exec -it ollama ollama pull tinyllama

Vous pouvez télécharger différents modèles, une référence complète de tous les modèles Ollama est disponible ici : https://ollama.com/library.

Remarque : La première fois que vous exécutez l'application, Docker prendra un certain temps pour télécharger toutes les images requises

Utilisation

Le panneau d'administration UI est accessible via http://localhost:8080, les identifiants par défaut sont

Nom d'utilisateur

[email protected]

Mot de passe

adminadmin

Sécurité : Les identifiants par défaut sont uniquement destinés au développement local. Si vous exposez l'application en dehors de localhost ou la mettez en production, créez un utilisateur administrateur et changez immédiatement le mot de passe. Ne conservez pas les identifiants par défaut activés.