Démonstration

Guide · Administrateurs

Préparer une installation dans votre infrastructure

Composants, services externes, secrets, exposition réseau et sauvegardes — la liste de contrôle avant d’installer EasyRag.

Avancé 20 minMis à jour le

Ce guide liste ce qu’il faut réunir avant d’installer la plateforme EasyRag sur vos serveurs. Il ne remplace pas la documentation du wiki EasyRag : il vous permet de préparer l’environnement.

Les composants

Conteneur Rôle
API applicative (NestJS) Comptes, rôles, assistants, corpus, canaux, supervision — port 3000
Service RAG (Python) Extraction, vectorisation, recherche, agent — interne
Interface web (Flutter, nginx) Administration, portail, pages publiques
PostgreSQL 16 Base applicative
PostgreSQL + pgvector Index des documents
Redis 7 Files de traitement, limites de débit

Les images de l’API, du service RAG et de l’interface sont publiées sur Docker Hub (bpmconseil/easyrag-backend, bpmconseil/easyrag-llm, bpmconseil/easyrag-webapp).

Les services externes

  • Obligatoire : une clé OpenAI ou Mistral pour la vectorisation et les traitements internes.
  • Pour chaque assistant : un modèle de génération (fournisseur cloud, ou serveur Ollama / vLLM interne).
  • Recommandé : un serveur SMTP (vérification des inscriptions, mots de passe, alertes).
  • Selon les besoins : Mistral OCR, Serper (recherche web), fournisseur d’identité (OIDC, FranceConnect+, Google).

Les secrets à générer

Secret Usage
JWT_SECRET, JWT_REFRESH_SECRET Signature des sessions
ENCRYPTION_KEY Chiffrement des identifiants (32 octets encodés en base64)
Mots de passe PostgreSQL Bases applicative et vectorielle
INTERNAL_LLM_API_KEY Clé OpenAI ou Mistral interne

Générez-les aléatoirement (par exemple openssl rand -base64 32) et conservez-les hors du code, dans votre coffre de secrets.

L’exposition réseau

  • Placez l’interface et l’API derrière un proxy inverse HTTPS.
  • Renseignez CLIENT_ORIGIN avec l’adresse exacte de l’interface : sans cette valeur, l’API accepte toutes les origines.
  • Décidez de l’ouverture de l’inscription en libre-service et de la création automatique de comptes par SSO (SSO_AUTO_PROVISION).
  • Restreignez si besoin l’accès à /api/v1/docs (documentation d’API) et à /metrics.
  • Le service RAG et les bases ne doivent pas être exposés.

Exploitation

  • Sauvegardes : les deux bases PostgreSQL et le volume des documents importés.
  • Supervision : sondes /health et /ready de l’API ; métriques Prometheus ; traces OpenTelemetry (facultatif).
  • Mises à jour : sauvegarde, remplacement des images, redémarrage, vérification des sondes.
  • Environnements : le module de migration transfère assistants, corpus et paramètres d’une instance de recette vers la production, avec simulation et retour arrière.
  • Échelle : une seule instance de l’API applicative (certains états sont gardés en mémoire).

Licence

Sans licence, la plateforme fonctionne en mode gratuit limité (un corpus, cinq documents). Une licence Registered gratuite est obtenue par vérification d’e-mail ; la licence Pro s’obtient auprès de la communauté EasyRag. Contactez-nous pour préparer votre installation.