Déploiement de Docker Compose

Ce guide couvre le déploiement de HagiCode avec Docker Compose. Pour la plupart des utilisateurs, il s’agit du chemin de déploiement par défaut dans les environnements de développement, de test et de production.

Tutoriel vidéo

Si vous souhaitez d’abord voir le flux complet, commencez par le didacticiel vidéo :

Regardez le tutoriel vidéo sur Bilibili

Le contenu vidéo comprend :

• Démonstration complète du processus de déploiement de Docker Compose
• Instructions de génération et de modification du fichier de configuration
• Étapes de démarrage et de vérification du service
• Problèmes courants et solutions

Durée de la vidéo : environ 15 minutes

Docker Compose Builder

Docker Compose Builder est désormais disponible en tant qu’outil autonome sur https://builder.hagicode.com/. Utilisez ce site comme source principale pour générer la même classe de fichiers de configuration.

Utiliser le générateur de configuration

Vous pouvez utiliser Docker Compose Builder (site autonome) générer docker-compose.yml directement.

Le générateur prend en charge :

• ports personnalisés, noms de conteneurs et autres paramètres de base
• sélection de base de données intégrée ou externe
• différences automatiques entre les plateformes Windows/Linux
• gestion courante des autorisations de fichiers
• sélection de la source d’image en fonction de votre environnement réseau

Ouvrez le générateur →

Méthode recommandée

Docker Compose est le chemin de déploiement par défaut dans la plupart des cas car :

• l’isolation de l’environnement réduit les conflits de dépendance
• la pile de services HagiCode prise en charge peut démarrer ensemble
• la configuration, les mises à niveau et la maintenance sont plus faciles à maintenir cohérentes
• cela fonctionne bien pour les essais locaux, les tests et le déploiement en équipe

À propos du stockage des données par défaut

Les modèles Docker Compose actuellement pris en charge conservent les données via le chemin SQLite local par défaut. Dans la plupart des cas, vous n’avez pas besoin de provisionner un service de base de données distinct sur la machine hôte.

Conditions préalables

Avant de commencer, assurez-vous que Docker et Docker Compose sont installés sur votre système.

Installer Docker

Fenêtres

Téléchargez et installez Bureau Docker pour Windows

Après l’installation, assurez-vous que Docker Desktop est en cours d’exécution.

macOS

Téléchargez et installez Docker Bureau pour Mac

Après l’installation, assurez-vous que Docker Desktop est en cours d’exécution.

Linux

Installez Docker à l’aide de votre gestionnaire de packages :

Install Docker on Ubuntu/Debian

sudo apt-get update
sudo apt-get install docker.io docker-compose-plugin

Après l’installation, démarrez le service Docker :

sudo systemctl start docker
sudo systemctl enable docker

Vérifier l’installation

Après l’installation, exécutez les commandes suivantes pour vérifier que Docker et Docker Compose sont correctement installés :

docker --version
docker compose version

Démarrage rapide

1. Générer le fichier de configuration Docker Compose

Utiliser le générateur de configuration

Recommander d’utiliser Docker Compose Builder (site autonome) pour générer votre fichier de configuration.

Le générateur prend en charge :

• Plusieurs options de fournisseur d’API (Zhipu AI, Anthropic Official, API personnalisée)
• Configuration automatique de l’URL et du jeton de l’API
• Ports personnalisés, noms de conteneurs et autres configurations de base
• Configurer les données persistantes et les chemins du répertoire de travail
• Configurer automatiquement les différences entre les plateformes Windows/Linux
• Gérer intelligemment les problèmes d’autorisation de fichiers
• Sélection de la source d’image : en fonction de votre environnement réseau, sélectionnez la source d’image appropriée

🚀 Utilisez le générateur immédiatement →

1. Ouvert Docker Compose Builder (site autonome)
2. Remplissez la configuration selon vos besoins :
   • Sélectionnez le fournisseur d’API (Zhipu AI, Anthropic Official ou API personnalisée)
   • Configurer les ports, la base de données, le répertoire de travail et d’autres options
   • Sélectionnez la source de l’image : choisissez la source d’image appropriée en fonction de votre environnement réseau
3. Cliquez sur le bouton Générer pour obtenir le docker-compose.yml configuration
4. Enregistrez la configuration générée en tant que docker-compose.yml fichier
5. Si nécessaire, créez un .env fichier pour configurer les informations sensibles

Sélection de la source d’image

Le générateur prend en charge trois options de source d’image :

** Docker Hub **

• Adresse de l’image : newbe36524/hagicode:{tag}
• Scénarios applicables : convient aux utilisateurs disposant de l’accélération miroir Docker Hub
• Avantages : source d’images officielle, mises à jour opportunes, accès stable
• Remarques : L’accélération miroir devra peut-être être configurée dans certaines régions

Registre de conteneurs Azure (ACR)

• Adresse de l’image : hagicode.azurecr.io/hagicode:{tag}
• Scénarios applicables : convient aux utilisateurs qui ne peuvent pas accéder localement à Docker Hub
• Avantages : Fournit une source d’image alternative, résout les problèmes d’accès au réseau
• Remarques : Les images restent synchronisées avec Docker Hub, mais peuvent subir de brefs retards

** Registre de conteneurs Alibaba Cloud (ACR) **

• Adresse de l’image : registry.cn-hangzhou.aliyuncs.com/hagicode/hagicode:{tag}
• Scénarios applicables : convient aux utilisateurs domestiques, accès au réseau stable et rapide
• Avantages : nœuds nationaux Alibaba Cloud, vitesse d’accès rapide, haute stabilité
• Remarques : les images Alibaba ACR restent synchronisées avec Docker Hub, généralement dans les 30 minutes.

Recommandations pour la sélection de la source d’image

• Les utilisateurs nationaux recommandent Alibaba Cloud ACR : si vous êtes un utilisateur national, il est recommandé de donner la priorité à l’utilisation de la source d’image Alibaba Cloud ACR pour un accès rapide et stable.
• ** Docker Hub alternatif ** : si votre environnement réseau peut accéder à Docker Hub, vous pouvez également choisir Docker Hub comme source d’image
• Alternative Azure ACR : choisissez la source d’image Azure ACR uniquement si d’autres sources d’images ont des difficultés d’accès
• Synchronisation d’images : les images Alibaba Cloud ACR restent synchronisées avec Docker Hub, généralement dans les 30 minutes.
• Cohérence des versions : les balises d’image sont cohérentes dans les trois sources d’images, pas besoin de s’inquiéter des problèmes de version

Obtenir le jeton API

Vous devez configurer Claude API Token pour utiliser HagiCode :

Zhipu AI (recommandé) : Obtenir un jeton API →

• Accès domestique stable, réponse plus rapide
• Rapport qualité-prix élevé, adapté à un usage quotidien

Officiel anthropique : Obtenir un jeton API →

• Utilisation directe des services d’Anthropic

2. Démarrez les services

Exécutez la commande suivante dans le répertoire où se trouve votre docker-compose.yml est situé :

docker compose up -d

Cette commande va :

• Téléchargez et démarrez les conteneurs HagiCode définis par le modèle généré
• Créer et configurer le réseau
• Initialiser le répertoire de données par défaut et les dépendances d’exécution

3. Vérifier l’état du service

Vérifiez si les conteneurs sont en cours d’exécution :

docker compose ps

Vous devriez voir les services définis dans votre modèle généré à l’état « en cours d’exécution ».

Afficher les journaux de service

Pour afficher tous les journaux de service :

# View all service logs
docker compose logs

# View HagiCode service logs
docker compose logs hagicode

# Real-time log following
docker compose logs -f hagicode

Instructions de configuration

Si vous devez modifier la configuration (par exemple changer de port, changer de fournisseur d’API, etc.), vous pouvez :

1. Régénérez la nouvelle configuration en utilisant Docker Compose Builder (site autonome)
2. Modifier manuellement docker-compose.yml et .env fichiers
3. Redémarrez les services pour que la configuration prenne effet :

docker compose restart

Demande d’accès

Interface Web

Après le démarrage réussi du service, accédez via votre navigateur :

http://localhost:45000

Persistance des données

Le chemin Docker Compose pris en charge utilise par défaut des fichiers de données SQLite avec des volumes persistants. Si vous devez inspecter les points de montage ou planifier des sauvegardes, examinez les mappages de volume et de répertoire de données dans le fichier généré. docker-compose.yml.

Prochaines étapes

Vous avez maintenant déployé HagiCode avec succès. Ensuite, connectez un projet réel dans l’interface Web, puis continuez avec Assistant de configuration ou Créer une session de proposition.

Si vous préférez la méthode de déploiement d’applications de bureau, veuillez vous référer à Guide d’installation du bureau.