NotariumDocumentation
Version de la documentation: latest
FR

Installation et démarrage

Notarium se distribue sous la forme d'une seule image autonome : un unique processus sert l'interface web, l'API REST et le point d'accès MCP pour les agents, tandis que le moteur de connaissances tourne directement à l'intérieur. Aucun service externe n'est requis — ni base de données, ni broker de messages, ni moteur de recherche séparé. Pour démarrer, il vous suffit de Docker et d'un port libre.

Cette page décrit le chemin le plus rapide : lancer une instance, l'ouvrir dans un navigateur et créer le propriétaire. L'auto-hébergement détaillé (Postgres, reverse proxy, configuration de production) est traité dans la section Auto-hébergement.

Ce dont vous aurez besoin

  • Docker (ou Docker Desktop) — rien d'autre à installer : Node, la base de données et l'index de recherche sont déjà dans l'image.
  • Un port libre — 3000 par défaut.
  • Un peu d'espace disque pour vos notes et l'index dérivé.

Lancer un seul conteneur

Le chemin le plus court consiste à lancer l'image préconstruite docouno/notarium :

docker run -d --name notarium \
  -p 3000:3000 \
  -v notarium-data:/data \
  docouno/notarium:latest

Après quelques secondes, ouvrez http://localhost:3000.

Un unique volume /data contient tout l'état — la base de métadonnées, les index, vos notes et les artefacts d'export. Il n'y a rien d'autre à configurer : le port 3000 et le chemin /data sont déjà intégrés à l'image. Vous pouvez remplacer le port à gauche de 3000 par n'importe quel port libre.

Construire depuis les sources

Si l'image n'a pas encore été récupérée depuis le registre, construisez-la depuis les sources du dépôt principal de Notarium avec make up (voir ci-dessous) : le comportement est identique.

Une autre solution consiste à construire depuis les sources via make, le point d'entrée unique pour tout ce qui touche à Docker :

cp .env.example .env   # les valeurs par défaut fonctionnent — rien à remplir
make up                # construire l'image de prod et la démarrer → http://localhost:3000

D'autres commandes sont utiles au quotidien : make logs pour les journaux, make ps pour le statut, make down pour arrêter et supprimer, make sh pour ouvrir un shell dans le conteneur.

Volumes : où résident les données

Tout l'état réside dans un seul volume — c'est lui qu'il faut préserver lorsque vous recréez le conteneur :

VolumePoint de montageCe qu'il stocke
notarium-data/dataTout : vos notes (/data/spaces), la base de métadonnées (/data/meta.db), les index de recherche dérivés (/data/engine) et les artefacts d'export (/data/jobs)

Le principe clé est file-first : la source de vérité, ce sont les fichiers .md dans /data/spaces. Les index de recherche et le graphe dans /data/engine sont dérivés : ils se reconstruisent à partir des fichiers, donc si vous les perdez, une réindexation les rétablit. La base de métadonnées /data/meta.db — historique des versions, utilisateurs et accès — n'existe que dans le volume, si bien que /data mérite le même soin que vos notes. Pour les sauvegardes, seuls vos notes et meta.db sont indispensables ; les index dérivés peuvent être laissés de côté.

Votre propre port

Changez le port 3000 du côté gauche de -p <le vôtre>:3000 (ou via la variable PORT dans .env). L'image écoute sur toutes les interfaces du conteneur — elle n'expose que ce que vous mappez.

Premier démarrage : l'écran de configuration initiale

Lors de votre première visite, Notarium vous accueille avec un écran de configuration initiale. Aucun mot de passe n'est prédéfini : le premier visiteur crée le propriétaire de l'instance — ce compte devient l'administrateur et le propriétaire des espaces qu'il crée. Ensuite, la configuration initiale se ferme définitivement, et vous arrivez dans l'éditeur, déjà à l'intérieur de votre espace personnel.

C'est ainsi que fonctionne le mode d'authentification par défaut — AUTH_MODE=password. Il est conçu pour une instance accessible publiquement : connexion, sessions, jetons personnels pour les agents. Le second mode, none (un unique principal ayant tous les accès, sans écran de connexion), ne convient qu'à un environnement de confiance : un poste de travail, du développement local ou un intranet fermé. Les détails figurent dans la section Authentification.

Configuration de base

Les valeurs par défaut sont zéro-config : l'image telle quelle suffit pour démarrer. Le réglage fin passe par les variables d'environnement (avec Docker, .env les transmet ; rien n'est figé dans l'image) :

VariableValeurPar défaut
PORTLe port sur lequel le serveur écoute3000
AUTH_MODEpassword (connexion + configuration initiale) ou none (environnement de confiance)password
VECTOR_SEARCHActiver la recherche sémantique (vectorielle) en complément de la recherche lexicaleoff dans l'image

La recherche plein texte fonctionne toujours, sans aucune configuration. La recherche sémantique (vectorielle) est optionnelle, activée par le drapeau VECTOR_SEARCH=on : elle charge un modèle d'embeddings local (de l'ordre de plusieurs centaines de mégaoctets de RAM), c'est pourquoi elle est désactivée dans l'image publiée et doit être activée délibérément. Sans elle, la recherche continue de fonctionner sur le texte intégral — sans erreur ; c'est le mode normal. La liste complète des variables et la configuration de la recherche se trouvent dans les sections Configuration et Configuration de la recherche.

Étapes suivantes

L'instance tourne et le propriétaire est créé — il est temps de remplir votre base de connaissances et de l'ouvrir à un agent :

Vous voulez comprendre le modèle dans son ensemble ? Consultez la section Concepts : les espaces, les types de notes, le graphe et le modèle d'accès.