N nooloom · guide d'utilisation
Démarrage

Installer Nooloom

Nooloom tourne dans un ensemble de conteneurs Docker Compose. En quelques commandes, vous obtenez l'application, l'API et tous les services (crawler, bases, agents…).

Prérequis

  • make — les commandes passent toutes par le Makefile.
  • Docker Compose v2.20+ — l'ensemble des services.
  • Environ 12 Go de RAM recommandés pour toute la stack locale.

Initialisation

Depuis la racine du projet, initialisez l'environnement : cela crée le fichier .env, les volumes Docker et génère les secrets manquants.

make setup

Configuration

Éditez ensuite .env : renseignez les identifiants Google OAuth et les clés d'API (OpenRouter pour le LLM, Datalab/Morph pour l'OCR).

# Identifiants Google OAuth (obligatoire)
GOOGLE_CLIENT_ID=votre-client-id
GOOGLE_CLIENT_SECRET=votre-client-secret
GOOGLE_REDIRECT_URI=http://localhost:8000/api/v1/auth/google/callback

# Clés d'API services
OPENROUTER_API_KEY=sk-or-...
MARKER_API_KEY=...

Les secrets requis

make setup renseigne automatiquement les secrets s'il détecte des placeholders. S'ils sont absents, définissez-les vous-même :

VariableMinimumRôle
JWT_SECRET32+ caractèresSigne les jetons d’accès (access token).
JWT_REFRESH_SECRET32+ caractèresSigne les jetons de rafraîchissement (refresh token).
INTERNAL_API_KEYHMACSigne les appels service-à-service (x-internal-key).
MONGODB_ROOT_PASSWORDforteMot de passe root de MongoDB.
REDIS_PASSWORDforteMot de passe de Redis (cache & files).

Démarrage

Lancez la stack de développement (hot reload) :

make dev

Le frontend est servi sur http://localhost:5173. Pour démarrer ou reconstruire tous les services modifiés en une commande, utilisez make up ; pour tout arrêter, make down.

Premier lancement

Le premier démarrage télécharge et construit toutes les images : comptez plusieurs minutes. Vérifiez l'état avec make health.

Première connexion

Nooloom s'utilise via Google OAuth (pas de mot de passe). Au premier login, votre organisation « My organisation » est créée automatiquement en plan gratuit ; le premier utilisateur connecté devient admin.

app.novaretail.example/login
Écran de connexion Google
L'écran de connexion : cliquez sur « Se connecter avec Google » (1). L'authentification est gérée par Google.

Une fois connecté, vous accédez au frontoffice. Pour administrer l'organisation (créer des crawlers, workflows, bases, agents…), basculez vers le backoffice depuis le menu en haut à droite.

Commandes utiles

CommandeAction
make devDéveloppement (hot reload)
make upBuild + démarre les services modifiés
make downArrête tous les services
make healthÉtat de santé des services
make testTous les tests (unit + intégration + e2e) + rapports HTML
make test-e2eTests end-to-end (Playwright)
À partir de zéro

Si vous repartez d'un dépôt vierge : make setup puis make dev. Pour un déploiement en production, le dépôt d'exemple nooloom-prod-example fournit une configuration prête (docker-compose.prod.yml + .env.example) : copiez .env.example vers .env puis renseignez vos vrais secrets.