flowchart TD
subgraph Docker["Docker Compose"]
subgraph network["clea-network"]
DB[(PostgreSQL<br/>pgvector)]
API[clea-api<br/>FastAPI Backend]
WEBUI[clea-webui<br/>SvelteKit Frontend]
NGINX[nginx<br/>Reverse Proxy]
DB <--> |5432| API
API <--> |8080| WEBUI
API <--> |8080| NGINX
WEBUI <--> |3000| NGINX
end
VOLUME[(Volume:<br/>vectordb_data)]
DB --- VOLUME
end
USER((Utilisateur)) --> |Port 80<br/>HTTP| NGINX
style Docker fill:#f5f5f5,stroke:#ddd,stroke-width:1px
style network fill:#e6f7ff,stroke:#91d5ff,stroke-width:1px
style VOLUME fill:#f6ffed,stroke:#b7eb8f,stroke-width:1px
style USER fill:#fff1f0,stroke:#ffa39e,stroke-width:1px
style NGINX fill:#f0f5ff,stroke:#adc6ff,stroke-width:1px
style API fill:#fff7e6,stroke:#ffd591,stroke-width:1px
style WEBUI fill:#f9f0ff,stroke:#d3adf7,stroke-width:1px
style DB fill:#e6fffb,stroke:#87e8de,stroke-width:1px
CLÉA est une plateforme complète d'exploration documentaire intelligente combinant:
- Un backend API Python pour la recherche vectorielle et le RAG
- Une interface utilisateur moderne et intuitive en SvelteKit
- Une base de données PostgreSQL avec l'extension pgvector
- Un serveur nginx pour orchestrer le tout
Ce dépôt contient la configuration Docker Compose permettant de déployer l'ensemble de la solution en quelques commandes.
Le système CLÉA se compose de quatre services principaux:
- db: Base de données PostgreSQL avec pgvector pour le stockage vectoriel
- api: Backend FastAPI (clea-api) gérant l'extraction, l'indexation et la recherche
- webui: Frontend SvelteKit (clea-webui) offrant l'interface utilisateur
- nginx: Reverse proxy qui coordonne les requêtes entre le frontend et l'API
L'architecture utilise un réseau partagé clea-network et un volume persistant pour les données.
- Chargement multi-formats: PDF, DOCX, TXT, et plus encore
- Recherche sémantique avancée: Recherche hybride (vectorielle + SQL)
- Assistant IA: Génération RAG avec modèles locaux
- Interface moderne: Dashboard intuitif, explorateur de documents, visualisations
- 100% local: Aucune dépendance cloud, traitement hors-ligne pour données sensibles
- Orchestration complète: Déploiement intégré via Docker Compose
- Docker Engine 24.0+
- Docker Compose V2
- 8GB RAM minimum (16GB recommandé)
- 10GB d'espace disque libre
- CPU compatible avec opérations vectorielles (pour performances optimales)
# Cloner le dépôt
git clone --recurse-submodules https://github.com/WillIsback/Clea.git
cd Clea
# Lancer l'ensemble des services
docker compose up -d
# Vérifier que tout fonctionne
docker compose ps| Service | Port interne | Port externe par défaut |
|---|---|---|
| db | 5432 | 5432 |
| api | 8080 | 8080 |
| webui | 3000 | 3000 |
| nginx | 8888 | 8888 |
Principales variables configurables dans le fichier .env:
# Configuration Docker Compose
COMPOSE_BAKE=true
# Configuration de la base de données
DB_USER=postgres
DB_PASSWORD=password
DB_NAME=vectordb
DB_PORT=5432
# Configuration des ports
API_PORT=8080
UI_PORT=3000
NGINX_PORT=80Une fois démarré, accédez à:
- Interface web: http://localhost:80 (ou le port configuré pour nginx)
- API directe: http://localhost:8080 (documentation OpenAPI disponible à /docs)
- Base de données: accessible sur le port 5432 (utile pour administration directe)
Clea/
# Suivre tous les logs
tail -f logs/*
# Suivre les logs d'un service spécifique (erreur)
tail -f logs/*.err./start-local-supervisor.sh- Toutes les données restent en local (rien n'est envoyé vers des services externes)
- CLÉA est conçu pour fonctionner en environnement air-gapped (sans internet)
- Les modèles d'IA sont exécutés localement
- Aucun tracking ni télémétrie
Les contributions sont les bienvenues! N'hésitez pas à:
- Forker le projet
- Créer une branche (
git checkout -b feat/nouvelle-fonctionnalite) - Commiter vos changements (
git commit -m 'Ajout: nouvelle fonctionnalité') - Pousser vers la branche (
git push origin feat/nouvelle-fonctionnalite) - Ouvrir une Pull Request
Distribué sous licence MIT. Voir LICENSE pour plus d'informations.
Développé avec ❤️ pour faciliter l'exploration documentaire intelligente.