docs: add step-by-step installation guide for effi-ocr

2026-04-08 22:06:31 +02:00
parent 0fad1d7249
commit 339dac1435
1 changed files with 180 additions and 0 deletions
@@ -0,0 +1,180 @@
+# Guide Pas à Pas - Git et effi-ocr
+
+Ce guide va te permettre de :
+1. Récupérer les mises à jour depuis Gitea
+2. Installer effi-ocr sur effi-server
+
+---
+
+## AVANT DE COMMENCER
+
+Tu as besoin de savoir :
+- **Tu es connecté en SSH sur effi-server (192.168.1.27)**
+- Ton nom d'utilisateur : `effi`
+
+---
+
+## PARTIE 1 : Récupérer les mises à jour (git pull)
+
+### Étape 1.1 : Vérifier le dossier
+
+```bash
+ls -la ~/effi
+```
+
+**Attendu** : Tu dois voir des fichiers comme `docker-compose.yml`, `effi-ocr/`, etc.
+
+**Si erreur** : "No such file or directory" → Va à la PARTIE 3
+
+### Étape 1.2 : Faire la mise à jour
+
+```bash
+cd ~/effi
+git pull origin main
+```
+
+**Attendu** : Ça affiche des messages et finit par "Already up to date" ou récupère des fichiers.
+
+---
+
+## PARTIE 2 : Installer effi-ocr sur effi-server
+
+### Étape 2.1 : Vérifier Docker
+
+```bash
+docker --version
+docker compose version
+```
+
+**Attendu** : Les deux commandes affichent une version (ex: "Docker version 24.0.7")
+
+**Si erreur** : Docker n'est pas installé → Dis-moi !
+
+### Étape 2.2 : Vérifier que le fichier docker-compose existe
+
+```bash
+ls -la ~/effi/docker-compose-ocr.yml
+```
+
+**Attendu** : Le fichier existe
+
+### Étape 2.3 : Lancer effi-ocr
+
+```bash
+cd ~/effi
+docker compose -f docker-compose-ocr.yml up -d --build
+```
+
+**Attendu** : Docker télécharge des fichiers et démarre le service
+
+### Étape 2.4 : Vérifier que ça marche
+
+```bash
+curl http://localhost:8300/health
+```
+
+**Attendu** : `{"status":"healthy","service":"effi-ocr",...}`
+
+### Étape 2.5 : Vérifier dans Docker
+
+```bash
+docker ps | grep effi-ocr
+```
+
+**Attendu** : Une ligne avec "effi-ocr" et statut "Up"
+
+---
+
+## PARTIE 3 : Si le dossier effi n'existe pas (clone)
+
+### Étape 3.1 : Cloner le repo
+
+```bash
+cd ~
+git clone https://gitea.folzocorp.fr/Folzo/effi.git
+```
+
+**Attendu** : Ça télécharge les fichiers
+
+### Étape 3.2 : Continuer depuis l'Étape 2
+
+Refais les étapes 2.1 à 2.5
+
+---
+
+## PARTIE 4 : Configurer OpenWebUI
+
+### Étape 4.1 : Modifier l'URL OCR dans OpenWebUI
+
+1. Ouvre dans ton navigateur : http://192.168.1.27:3000
+2. Clique sur ton **profil** (en bas à gauche)
+3. Clique **Admin Panel**
+4. Clique **Settings** → **Environment Variables**
+5. Cherche `OCR_URL`
+6. Change la valeur pour : `http://host.docker.internal:8300`
+7. Clique **Save**
+
+### Étape 4.2 : Recréer le Tool OCR (si nécessaire)
+
+1. **Admin Panel** → **Tools**
+2. Cherche "OCR" existant et supprime-le
+3. Clique **Create Tool**
+4. Name : `effi-ocr`
+5. ID : `effi_ocr`
+6. Description : `Extrait le texte des images avec OCR`
+7. Copie le code Python depuis : `~/effi/effi-ocr/TOOL-OPENWEBUI.md`
+8. Clique **Save**
+
+---
+
+## PARTIE 5 : Tester
+
+### Étape 5.1 : Test effi-ocr directement
+
+```bash
+curl http://localhost:8300/health
+```
+
+### Étape 5.2 : Test dans OpenWebUI
+
+1. Ouvre http://192.168.1.27:3000
+2. Active le tool OCR dans la conversation
+3. Envoie une image avec le prompt :
+```
+Utilise effi-ocr pour extraire le texte de cette image
+```
+
+---
+
+## COMMANDE UTILES
+
+```bash
+# Voir les logs d'effi-ocr
+docker logs effi-ocr -f
+
+# Arrêter effi-ocr
+docker compose -f ~/effi/docker-compose-ocr.yml down
+
+# Redémarrer effi-ocr
+docker restart effi-ocr
+
+# Mettre à jour (après git pull)
+docker compose -f ~/effi/docker-compose-ocr.yml up -d --build
+```
+
+---
+
+## SI ÇA NE MARCHE PAS
+
+### Erreur "Fichier non trouvé"
+→ effi-ocr n'est pas sur le même serveur qu'OpenWebUI
+
+### Erreur de connexion
+→ Vérifier que effi-ocr tourne : `docker ps | grep effi-ocr`
+
+### OCR URL incorrecte
+→ Vérifier dans OpenWebUI → Settings → Environment Variables
+
+---
+
+*Document créé: Avril 2026*