Guide officiel
📘 Bienvenue dans ObsiGate
ObsiGate est votre porte d'entrée web vers
vos vaults Obsidian. Accédez, naviguez et
recherchez dans toutes vos notes depuis
n'importe quel appareil via une interface
moderne et responsive.
⚡ Navigation rapide
🗂️ Multi-vault
🏷️ Tags intelligents
📝 Lecture et édition
🔍 Recherche TF-IDF
Expérience
Simple
Recherche
Instantanée
Accès
Multi-vault
🏗️ Architecture
ObsiGate est une application web complète construite en couches indépendantes, sans base de données externe : les notes vivent dans vos dossiers Obsidian, l'état applicatif dans des fichiers JSON de data/, l'index de recherche en mémoire.
flowchart TB
subgraph client["Clients"]
UI["SPA vanilla JS\n(frontend/js)"]
PWA["PWA hors-ligne\n(service worker + IndexedDB)"]
DESK["App desktop Tauri\n(fenêtre native)"]
end
subgraph server["Serveur FastAPI (Python 3.11)"]
API["REST /api\nJWT + Argon2id"]
IDX["Index recherche\nTF-IDF + embeddings"]
FS["Accès fichiers\nwatchdog + safe paths"]
PDF["Rendu markdown\nmistune + WeasyPrint"]
AI["Assistant IA\nproviders + outils"]
MCP["Serveur MCP\n/mcp (HTTP)"]
WS["WebSocket\ncollab Yjs + SSE"]
WH["Webhooks\nHMAC-SHA256"]
end
subgraph data["Données"]
V1["Vault 1 (dossier)"]
V2["Vault 2 (dossier)"]
CFG["data/*.json\nconfig, users, audit"]
BK[".obsigate-backup/\nbackups horodatés"]
end
UI -- HTTP --> API
PWA -- "cache + queue" --> API
DESK -- embarqué --> API
API --> IDX
API --> FS
API --> PDF
API --> AI
MCP --> AI
WS --> FS
FS --> V1
FS --> V2
IDX --> V1
IDX --> V2
BK --> V1
API --> CFG
API -- événements --> WH
Le diagramme est interactif dans l'application : zoom, plein écran, copie SVG ou code.
Les grandes composantes
-
Frontend — SPA en JavaScript vanilla (modules ES), sans framework ni build npm :
frontend/js/ (~30 modules). Le CSS utilise des variables pour les thèmes.
-
Backend — serveur FastAPI (Python 3.11) : rendu markdown (mistune + wikilinks), recherche TF-IDF stemmisée (index inversé en mémoire), watchers watchdog, JWT + Argon2id, webhooks HMAC, export PDF (WeasyPrint).
-
Temps réel & MCP — passerelle WebSocket (collaboration Yjs, notifications SSE/push) et serveur MCP (Streamable HTTP,
/mcp) pour les clients externes.
-
Couche IA — assistants d'édition et BooksLM multi-providers (DeepSeek, OpenRouter, Gemini, Mistral…), bibliothèque d'outils (function calling, recherche web, crawl, lecture de documents) et embeddings optionnels pour la recherche sémantique.
-
Données — les vaults Obsidian sur disque (source de vérité), la configuration en JSON (
data/), les backups horodatés (.obsigate-backup/), l'audit en JSON lines, les clés API chiffrées dans data/api_keys.json.
-
Déploiement — application desktop Tauri (Rust) embarquant le backend Python, conteneur Docker, ou PWA installable dans le navigateur (mode hors-ligne).
Flux typique
Un clic sur un fichier émet GET /api/file/... ; le backend résout le chemin en sécurité, parse le frontmatter, rend le markdown et renvoie le HTML ; le frontend enrichit l'affichage (Mermaid, coloration, wikilinks cliquables). Chaque écriture crée un backup avant application.
🧭 Interface utilisateur
En-tête
La barre supérieure contient les éléments
essentiels :
-
Bouton menu hamburger
: obile) : Affiche/masque la sidebar
-
Bouton toggle sidebar (desktop) : Masque la sidebar pour plus
d'espace
-
Logo ObsiGate : Retour à
l'accueil
-
Barre de recherche :
Recherche globale avec autocomplétion
-
Indicateur de vault :
Affiche le contexte actif (All, vault1,
etc.)
-
Menu Options : Accès aux
paramètres, thème, aide
Sidebar (barre latérale)
La sidebar est divisée en deux onglets :
-
Vaults : Arborescence des
fichiers et dossiers
-
Tags : Nuage de tags
cliquables
-
Compte : Avatar, nom,
rôle et déconnexion en bas de la sidebar
Fonctionnalités de la sidebar :
-
Filtrage : Barre de
recherche pour filtrer fichiers/tags
-
Sélection rapide : Dropdown
pour changer de vault
-
Redimensionnement : Glissez
le bord droit pour ajuster la largeur
-
Masquage : Cliquez sur
l'icône sidebar dans le header
Zone de contenu
La zone centrale affiche :
-
Breadcrumb : Chemin du
fichier (cliquable pour repositionner la
sidebar)
-
Titre et tags : Métadonnées
du fichier
-
Boutons d'action : Copier,
Source, Télécharger, Éditer, Ouvrir dans
nouvelle fenêtre
-
Contenu rendu : Markdown
avec wikilinks et images
Notifications web (push)
Autorisez les notifications (bouton 🔔 de l'en-tête) pour être averti des fins de synchronisation hors-ligne et des événements importants. La gestion des abonnements est dans les Configurations.
Basée sur la Web Push API (clés VAPID) ; fonctionne sur desktop et PWA mobile, sans service tiers : le serveur émet directement vers les endpoints push des navigateurs.
🗺️ Navigation
Arborescence des vaults
Cliquez sur un vault pour l'ouvrir et voir son
contenu. Les dossiers affichent un chevron et un
badge avec le nombre d'éléments.
-
Développer/Réduire:
Cliquez sur un dossier
-
Ouvrir un fichier: Cliquez
sur le nom du fichier
-
Icônes : Chaque type de
fichier a son icône (markdown, code, etc.)
Filtrage de la sidebar
Utilisez la barre de filtrage en haut de la
sidebar pour rechercher rapidement :
-
Recherche instantanée:
Tapez pour filtrer fichiers et dossiers
-
Case-sensitive: Bouton
"Aa" pour respecter la casse
-
Effacer : Bouton "×" pour
réinitialiser le filtre
-
Résultats groupés:
Affichage par vault avec chemins complets
Breadcrumb et repositionnement
Le chemin affiché au-dessus du contenu est
interactif :
-
Cliquez sur le vault:
Focus sur le vault dans la sidebar
-
Cliquez sur un segment:
Navigation vers ce dossier
-
Auto-scroll: La sidebar se
positionne automatiquement
Sélection de vault
Changez de contexte pour filtrer l'affichage :
-
Menu header: Dropdown
"Vault" dans le menu Options
-
Sidebar dropdown :
Sélection rapide en haut de l'onglet Vaults
-
Tous les vaults: Vue
globale de tous vos contenus
-
Vault spécifique: Focus
sur un seul vault
📑 Gestion des onglets
ObsiGate supporte l'ouverture de plusieurs
fichiers simultanément dans des onglets.
Ouverture d'onglets
-
Simple clic : Ouvre le
fichier dans un onglet temporaire (aperçu,
italique)
-
Double clic: Ouvre le
fichier dans un onglet persistant
-
Navigation récente :
L'onglet "Récent" dans la sidebar liste vos
derniers fichiers
Navigation entre onglets
-
Clic sur un onglet: Active
l'onglet
-
Ctrl+Tab: Onglet suivant
-
Ctrl+Shift+Tab : Onglet
précédent
-
Ctrl+W: Fermer l'onglet
actif
-
Bouton ✕: Ferme l'onglet
(sauf s'il est seul)
Fonctionnalités
-
Barre d'onglets : Affichage
horizontal avec le nom du fichier et son
icône
-
Onglet actif : Surligné en
couleur d'accentuation
-
Prévisualisation : Un
onglet temporaire (italique) est remplacé
par le prochain clic
-
Onglets persistants :
Restent ouverts jusqu'à fermeture manuelle
🔍 Recherche
Recherche simple
Tapez dans la barre de recherche en haut pour
lancer une recherche fulltext :
-
Recherche dans tout:
Titre, contenu, tags, chemins
-
Scoring intelligent :
Résultats classés par pertinence TF-IDF
-
Snippets surlignés:
Extraits avec termes en surbrillance
-
Pagination : Navigation par
pages de 50 résultats
Opérateurs avancés
Utilisez des opérateurs pour affiner votre
recherche :
-
tag:docker ou
#docker : Filtrer par tag
-
vault:IT : Rechercher dans un
vault spécifique
-
title:kubernetes : Chercher
dans les titres uniquement
-
path:recettes/soupes : Filtrer
par chemin
-
ext:md : Filtrer par type de
fichier
-
"phrase exacte" : Recherche de
phrase entre guillemets
Exemples:
ext:sh recherche dans les scripts
bash, ext:py dans les scripts
Python, ext:md dans les fichiers
Markdown.
Exemple combiné :
tag:linux vault:IT ext:md serveur web
recherche "serveur web" dans les fichiers
Markdown du vault IT avec le tag linux.
Autocomplétion
L'autocomplétion vous aide à trouver rapidement
:
-
Historique : Les 50
dernières recherches (localStorage)
-
Fichiers: Suggestions de
titres de fichiers
-
Tags: Suggestions de tags
avec compteurs
-
Navigation clavier : ↑/↓
pour naviguer, Enter pour sélectionner
Chips de filtres actifs
Les opérateurs utilisés s'affichent sous forme
de chips colorés :
-
Visualisation: Voir d'un
coup d'œil les filtres actifs
-
Suppression: Cliquez sur
"×" pour retirer un filtre
-
Couleurs : Chaque type
d'opérateur a sa couleur
Facettes et tri
Les résultats incluent des facettes pour affiner
:
-
Facettes tags : Compteurs
par tag dans les résultats
-
Facettes vaults: Compteurs
par vault
-
Tri par pertinence : Score
TF-IDF (défaut)
-
Tri par date : Dernière
modification
Recherche sémantique (hybride)
Activez le bouton « S » de la barre de recherche (ou Alt-S) pour combiner TF-IDF et similarité vectorielle (fusion RRF) : les concepts approchants (« velours » trouve « tissu doux ») remontent mieux.
Le moteur d'embeddings (modèle multilingue) est optionnel : sans lui, un repli par hash conserve une recherche hybride fonctionnelle. Les vecteurs sont recalculés à chaque indexation du vault.
📄 Fichiers
Visualisation
Les fichiers markdown sont rendus avec :
-
Wikilinks cliquables:
[[lien]] et
[[lien|texte]]
-
Images Obsidian: Support
de
![[image.png]]
-
Syntax highlighting:
Coloration des blocs de code
-
Tables, listes, quotes:
Rendu complet du markdown
Actions sur fichiers
Boutons disponibles au-dessus du contenu :
-
Copier: Copie le contenu
source dans le presse-papiers
-
Source: Affiche/masque le
markdown brut
-
Télécharger : Télécharge le
fichier
-
Éditer : Ouvre l'éditeur
CodeMirror
-
Ouvrir dans nouvelle fenêtre: Ouvre le fichier dans un nouvel onglet
Édition avec CodeMirror 6
L'éditeur intégré offre :
-
Coloration syntaxique:
Support de nombreux langages
-
Numéros de ligne:
Navigation facile
-
Autocomplétion:
Suggestions contextuelles
-
Recherche: Ctrl+F pour
chercher dans le fichier
-
Sauvegarde: Bouton ✓ pour
enregistrer
-
Suppression: Bouton
corbeille pour supprimer
Types de fichiers supportés
ObsiGate indexe et affiche :
-
Markdown : .md (rendu
complet)
-
Code : .py, .js, .ts, .jsx,
.tsx, .java, .c, .cpp, .rs, .go, etc.
-
Config : .json, .yaml,
.yml, .toml, .xml, .ini, .env
-
Scripts : .sh, .bash, .ps1,
.bat
-
Web : .html, .css, .scss
-
PDF : .pdf (visualiseur natif, texte indexé)
-
Excalidraw : .excalidraw,
.excalidraw.md
-
Autres : .txt, .log, .sql,
.csv
Export PDF
Le bouton « PDF » d'un document le rend avec le même moteur que la vue (WeasyPrint) : titres, tableaux, listes et code sont conservés. Depuis un lien public, la route /s/{token}/pdf produit le même PDF.
Export HTML / ePub / ZIP
Le menu « Exporter » propose trois formats : HTML autonome (fichier unique, images incluses), ePub pour les liseuses et, pour un dossier, un bundle Markdown en ZIP — liens et ressources résolus pendant l'export.
Anti-doublons à l'upload
L'upload en masse (glisser-déposer un dossier sur la sidebar) compare chaque fichier au contenu existant : un fichier déjà présent est ignoré plutôt que dupliqué avec un suffixe « (1) ». Utile pour restaurer un vault sans créer de doublons.
🎨 Diagrammes Excalidraw
Les fichiers .excalidraw et
.excalidraw.md s'ouvrent dans un éditeur visuel
Excalidraw complet, intégré dans une iframe sandboxée.
Ouverture
-
Cliquez sur un fichier
.excalidraw dans
l'arborescence : l'éditeur s'ouvre à la place du viewer markdown.
-
Dessinez, ajoutez des formes, du texte, des flèches et des
images — l'expérience Excalidraw complète.
Sauvegarde
-
Les modifications sont sauvegardées automatiquement (2 s) ou
avec Ctrl+S. L'éditeur suit le thème
clair/sombre.
Recherche
-
Le texte des éléments du diagramme est extrait à l'indexation :
il est donc recherchable via la recherche full-text.
-
Les fichiers créés avec le plugin Obsidian Excalidraw (y
compris le format
.excalidraw.md compressé) sont
compatibles.
📊 Diagrammes
Les blocs ```mermaid de vos notes sont rendus en diagrammes interactifs (Mermaid v11, chargé depuis un CDN).
- Zoom : boutons + / − dans la barre d'outils du diagramme.
- Plein écran : idéal pour les grandes matrices.
- Copie : exportez le SVG ou le code source (boutons dédiés).
- Bascule Aperçu / Code pour éditer la source sans quitter la vue.
- Thème : le diagramme suit le thème clair/sombre de l'application.
Types supportés : flowchart, sequence, class, state, ER, gantt, pie, journey, quadrant, radar, mindmap, timeline, C4, xychart, sankey — plus un préprocesseur qui comprend la syntaxe Obsidian.
Les dessins à main levée (.excalidraw, .excalidraw.md) sont couverts dans la section 🎨 Excalidraw.
✏️ Édition avancée
Éditeur CodeMirror 6
L'éditeur intégré offre une expérience complète
d'édition :
-
Coloration syntaxique:
Python, JS, HTML, CSS, Java, C++, Rust, Go
et bien d'autres
-
Numéros de ligne :
Navigation facilitée dans les fichiers longs
-
Find in page: Ctrl+F pour
chercher dans le fichier (casse, regex, mot
entier)
-
Sauvegarde automatique :
Auto-save silencieux après 2s d'inactivité,
flash vert de confirmation
-
Bouton ✓: Sauvegarde
manuelle
-
Bouton 🗑️: Suppression du
fichier
-
Barre d'outils AI :
Complétion, réécriture, traduction (voir
section🤖 IA)
📱 Édition mobile
Sur téléphone et tablette, l'édition s'adapte au
tactile : barre d'outils flottante, gestes et mode
lecture plein écran.
-
Barre d'outils flottante :
gras, italique, code, liste à puces et lien.
Les boutons A−/A+ ajustent la taille de la
police.
-
Presse-papiers :
bouton « Coller » persistant (contourne la
restriction iOS).
-
Gestes tactiles :
balayage vers la gauche → liens entrants,
vers la droite → table des matières.
-
Mode lecture :
plein écran sans en-tête ni barres latérales ;
balayage horizontal pour passer au fichier
suivant ou précédent.
-
Zoom & hauteur :
pincement à deux doigts pour zoomer, poignée
pour redimensionner la zone d'édition.
⭐ Bibliothèque
Signets & récents
Marquez un fichier d'un ★ (bouton Signet de la barre d'actions) : il rejoint la liste des signets du dashboard. Les fichiers récemment ouverts sont listés automatiquement dans l'onglet « Récents » de la sidebar, avec un filtre de recherche dédié.
Recherches sauvegardées
Enregistrez une recherche depuis la page de résultats pour la relancer en un clic depuis la sidebar : chaque recherche sauvegardée conserve ses opérateurs et filtres.
Backlinks & graphe
Le panneau Backlinks liste toutes les notes qui pointent vers le fichier ouvert. La vue Graphe (bouton 🕸️) affiche les liens entre fichiers : glissez les nœuds, zoomez à la molette, double-cliquez pour ouvrir une note.
Conflits de synchronisation
Si vous synchronisez le vault avec Syncthing, ObsiGate détecte les fichiers de conflit (copies « sync-conflict ») et propose de les comparer puis résoudre depuis la page dédiée du menu Options.
Fichiers joints & médias
Les images ![[image.png]], pièces jointes et médias (audio, vidéo, PDF intégrés) dans les notes sont rendus dans le viewer et indexés pour la recherche ; le bouton « Rescan attachments » de la configuration recrée l'index des pièces jointes.
🗺️ Vue Graphe
La vue graphe offre une visualisation
interactive des connexions entre vos notes via
les wikilinks.
Ouverture
-
Menu contextuel: Clic
droit sur un vault ou dossier → Vue
Graphique
-
Bouton dédié : Dans la
barre d'outils (le cas échéant)
Interaction
-
Zoom/Pan : Molette pour
zoomer, cliquer-glisser pour se déplacer
-
Slider de profondeur :
Contrôle la profondeur d'exploration (0-3)
-
Filtre par tag : N'affiche
que les nœuds avec un tag spécifique
-
Filtre par type:
Inclut/exclut fichiers, dossiers, markdown,
autres
-
Recherche visuelle: Barre
de recherche pour surligner des nœuds
-
Mode focus : Centre la vue
sur un nœud spécifique
-
Navigation ← → ↑:
Historique de navigation entre les nœuds
Affichage
-
Nœuds : Fichiers (carrés)
et dossiers (cercles) avec icônes
-
Arêtes: Wikilinks sortants
(bleu) et backlinks entrants (vert)
-
Panneau d'info :
Métadonnées du nœud (tags, liens, chemin)
-
Ctrl+survol : Aperçu du
contenu de la note sans naviguer
-
Plein écran: Bouton pour
agrandir la vue
-
Export PNG: Sauvegardez le
graphe en image
La vue utilise l'algorithme Barnes-Hut pour
calculer la disposition en O(n log n),
garantissant des performances fluides même avec
des centaines de nœuds.
🎨 Personnalisation
Thème clair/sombre
Basculez entre les thèmes :
-
Menu Options : Cliquez sur
"Thème" dans le menu
-
Raccourci :
Ctrl+T
-
Persistance : Votre choix
est sauvegardé en localStorage
-
Highlight.js : Les blocs de
code s'adaptent au thème
Redimensionnement de la sidebar
Sur desktop, ajustez la largeur de la sidebar :
-
Handle de redimensionnement
: Bordure droite de la sidebar
-
Glisser-déposer : Cliquez
et glissez pour ajuster
-
Limites : Min 200px, Max
500px
-
Persistance : La largeur
est sauvegardée
Configuration avancée
Le modal Configurations (menu Options) permet de
:
-
Paramètres de recherche :
Délai debounce, résultats par page, timeout
-
Paramètres backend :
Workers, boosts TF-IDF, expansions préfixe
-
Filtrage de tags : Patterns
pour masquer les tags template
-
Diagnostics : Stats index,
mémoire, moteur de recherche
-
Réindexation : Forcer un
rescan des vaults
Vue multi-panneaux (split view)
Le bouton « Diviser » de la barre d'actions ouvre le document dans un panneau jumeau ; empilez plusieurs panneaux pour comparer deux notes ou lire et éditer en parallèle. Les largeurs se règlent au bord des panneaux et sont mémorisées.
⌨️ Palette de commandes
La palette de commandes permet d'accéder
rapidement aux fichiers et aux actions sans
utiliser la souris.
Ouverture
-
Ctrl+Shift+Espace : Palette
de fichiers (recherche par titre)
-
Ctrl+Alt+Espace : Palette
de commandes (liste d'actions)
-
Tab : Bascule entre mode
fichiers et mode commandes
Mode fichiers
Tapez le nom d'un fichier pour le trouver
rapidement. La recherche utilise l'API
/api/suggest pour des suggestions
instantanées. Appuyez sur Enter pour
ouvrir le fichier sélectionné.
Mode commandes
Tapez > (ou Ctrl+Alt+Espace)
pour voir la liste des actions disponibles :
-
🏠 Accueil : Retour à
l'accueil
-
✏️ Éditer fichier courant :
Ouvre l'éditeur sur l'onglet actif
-
🪟 Pop-out : Ouvre le
document dans une fenêtre détachée
-
📄 Créer fichier markdown :
Crée un nouveau fichier .md et l'ouvre dans
l'éditeur
-
🗑️
Supprimer fichier courant :
Supprime le fichier de l'onglet actif
-
📁 Créer répertoire : Crée
un nouveau dossier
-
🗑️ Supprimer répertoire :
Supprime un dossier et son contenu
-
🌓 Changer le thème :
Bascule clair/sombre
-
🔄 Réindexer : Force la
réindexation complète
-
❓ Aide : Ouvre ce guide
-
⚙️ Configuration : Ouvre
les paramètres
Navigation
-
↑ ↓ : Se déplacer dans
la liste
- Enter : Ouvrir/sélectionner
- Esc : Fermer la palette
-
Tab : Basculer entre fichiers et
commandes
⌨️ Raccourcis clavier
Navigation
-
Ctrl+K ou Cmd+K :
Focaliser la barre de recherche
-
/ : Focaliser la recherche
(hors champ texte)
-
Escape : Fermer les suggestions
/ quitter la recherche
Recherche et autocomplétion
-
↑ / ↓ : Naviguer
dans les suggestions
-
Enter : Sélectionner la
suggestion active ou lancer la recherche
-
Escape : Fermer le dropdown de
suggestions
Interface
-
Ctrl+T : Basculer le thème
clair/sombre
-
Ctrl+Shift+Espace : Palette de
fichiers
-
Ctrl+Alt+Espace : Palette de
commandes
-
Escape : Fermer la palette /
les suggestions
Onglets
-
Ctrl+W : Fermer l'onglet actif
Ctrl+Tab : Onglet suivant-
Ctrl+Shift+Tab : Onglet
précédent
Éditeur CodeMirror
-
Ctrl+F : Rechercher dans le
fichier
Ctrl+Z : AnnulerCtrl+Y : Refaire-
Ctrl+S : Sauvegarder (si
configuré)
🤖 Intelligence Artificielle dans l'Éditeur
ObsiGate intègre un assistant IA directement
dans l'éditeur de texte. Pour l'activer,
configurez au moins un provider AI dans le
fichier .env (DeepSeek, OpenRouter
ou Gemini).
Activation
-
Ajoutez votre clé API dans
.env :
DEEPSEEK_API_KEY=sk-...
-
Redémarrez le conteneur :
docker compose down && docker compose
up -d --build
-
Ouvrez un fichier en mode Édition (bouton ✏️
Éditer)
-
La barre d'outils AI apparaît sous le titre
de l'éditeur
Barre d'outils AI
La barre d'outils contient les boutons suivants
:
-
✦ AI — Complétion inline
(Ctrl+J). Complète
automatiquement le texte là où se trouve le
curseur.
-
Éditer ▾ — Menu de
modification du texte sélectionné :
-
🪄
Improve writing :
Améliore la qualité, la clarté et le
flux du texte
-
🔤
Fix spelling & grammar
: Corrige les fautes d'orthographe
et de grammaire
-
📏 Make shorter :
Rend le texte plus concis tout en
préservant l'information
-
📐 Make longer :
Ajoute des détails, exemples ou
explications
-
📋
Simplify language :
Simplifie le langage, évite le
jargon
-
Ton ▾ — Change le ton du
texte :
-
💼 Professional :
Ton formel et professionnel
-
💬 Casual : Ton
décontracté et conversationnel
-
Traduire ▾ — Traduit le
texte sélectionné vers une autre langue :
-
🇬🇧 English · 🇨🇳 Chinese · 🇯🇵
Japanese · 🇩🇪 German · 🇫🇷 French ·
🇪🇸 Spanish
-
Générer ▾ — Génère du
contenu à partir de la sélection :
-
ℹ️ Explain this :
Explique le texte sélectionné de
façon claire
-
📝 Summarize :
Résume le texte de façon concise
-
✏️
Continue writing :
Continue l'écriture à partir du
texte
-
💬 Réécrire — Réécrit le
texte selon vos instructions personnalisées.
Une boîte de dialogue vous demande votre
instruction.
-
🧰 Boîte ▾ — Outils de
conversion :
-
📋
Convert to list :
Transforme le texte en liste
Markdown
-
📊
Convert to table :
Transforme en tableau Markdown
-
⚙️
Generate frontmatter
: Génère un bloc YAML frontmatter
-
🔷
Convert to canvas :
Convertit en diagramme Mermaid.js
Indicateurs visuels
-
Pendant une requête AI, un toast
⏳ AI: traitement en cours...
s'affiche
-
Une fois terminé,
AI: texte traité ✓ confirme
le succès
-
En cas d'erreur de clé API :
AI: clé API invalide
Sauvegarde automatique
L'éditeur sauvegarde automatiquement après 2
secondes d'inactivité. Le bouton de sauvegarde
flashe en vert brièvement pour
confirmer.
Providers supportés
| Provider |
Variable .env |
Modèle par défaut
| DeepSeek |
DEEPSEEK_API_KEY |
deepseek-chat |
| OpenRouter |
OPENROUTER_API_KEY |
openai/gpt-4o-mini |
| Gemini |
GEMINI_API_KEY |
gemini-2.0-flash |
Pour changer de provider par défaut :
AI_DEFAULT_PROVIDER=openrouter
🧠 Panneau Assistant (BooksLM)
L'assistant latéral (bouton flottant ou menu contextuel d'un
dossier) répond en Markdown formaté et contextualise vos
répertoires ou documents.
-
Réponses formatées : titres, listes, tableaux, citations et
blocs de code.
-
Le bouton « Ajouter » (au survol d'une réponse) insère la
réponse dans le document ouvert dans l'éditeur (Editer ou
Forge) ; chaque bloc de code propose « Ajouter la section »
pour n'insérer que ce bloc.
-
Les fichiers et chemins cités sont des liens : cliquez sur un
fichier pour l'ouvrir, sur un dossier pour le révéler dans
l'arborescence.
-
L'icône historique de l'en-tête liste les sessions passées
(recharger ou supprimer) ; « + » démarre une nouvelle
conversation.
-
Le bouton « mode agent » active les outils (lire, lister,
chercher) ; les actions de modification demandent une
confirmation avec aperçu des changements.
-
Les actions s'affichent dans le fil : l'assistant regroupe les
modifications en une seule approbation (« Tout approuver ») et
met à jour l'arborescence et le document ouvert dès qu'elles
sont appliquées. Le bouton d'envoi devient « Stop » pour
interrompre l'exécution à tout moment.
-
Le bord gauche du panneau est redimensionnable ; la largeur est
mémorisée.
-
Tapez
@ pour joindre un fichier ou un répertoire au
contexte, ou pour attacher une image d'un répertoire.
-
Tapez
/ pour lancer un skill (recherche, résumé,
correction, plan…) ou une commande admin
(/help, /providers,
/model, /keys).
-
Collez une image dans la zone de saisie (ou joignez-la) pour
l'analyser avec un modèle compatible vision. Le bouton ⓘ affiche
les capacités du modèle sélectionné, et la liste des modèles est
filtrable par recherche.
📴 Hors-ligne
- ObsiGate est une PWA : installez-la (icône d'installation de la barre d'adresse) pour l'ouvrir comme une application. Le service worker met en cache l'interface et vos derniers documents consultés.
- Hors-ligne, vous pouvez lire les documents en cache et même les éditer : les modifications sont mises en file d'attente dans IndexedDB.
- Au retour en ligne, la file se rejoue automatiquement (badge de synchronisation dans l'en-tête). Si la version serveur a divergé entre-temps, le fichier est marqué en conflit et la version serveur est préservée en backup.
- Les modifications externes (Obsidian sur disque) sont détectées par le watcher : la vue se recharge sans perte de position, ou signale « modifié en externe » pendant une édition.
👥 Collaboration
- Ouvrez un document en mode Édition : plusieurs personnes peuvent travailler simultanément sur le même fichier via un WebSocket Yjs (CRDT). Les modifications fusionnent sans verrou.
- Les curseurs et sélections des collaborateurs apparaissent avec une couleur et un nom par personne (awareness).
- La fusion est persistée côté serveur après 2 s d'inactivité ; chaque écriture crée un backup horodaté avant application.
- Accès limité aux utilisateurs authentifiés disposant de la permission sur la vault.
🖥️ Desktop
- L'application desktop ObsiGate (Tauri) embarque le serveur Python : aucune installation de Docker nécessaire. Elle se télécharge sur la page des Releases du dépôt et se met à jour automatiquement (updater signé).
- Au premier lancement, un assistant demande le dossier de vos vaults (ou crée un vault de démonstration). Chaque document peut être détaché en fenêtre native séparée.
- Les données desktop restent dans le répertoire applicatif ; les vaults pointent sur vos dossiers existants. Toutes les fonctionnalités web (recherche, IA, partage) sont disponibles.
- Menu système natif, raccourci global optionnel pour afficher/masquer la fenêtre et jumplist des vaults récents.
🔗 Partage et Webhooks
Publication publique
ObsiGate permet de partager des documents via un
lien public temporaire.
-
Bouton Partager : Dans les
actions du fichier, génère un lien unique
-
Token unique : 64
caractères hexadécimaux, impossible à
deviner
-
Expiration configurable :
Durée de vie en heures
-
Lecture seule : La vue
publique n'affiche que le contenu sans
édition
-
Gestion des liens : Liste
et révocation dans les Configurations
-
Export PDF : Téléchargement
du document partagé en PDF via
/s/{token}/pdf
🪝 Webhooks
Les webhooks permettent à ObsiGate de
notifier automatiquement des services
externes
lorsque des fichiers ou dossiers sont modifiés.
Chaque événement déclenche un
POST HTTP vers l'URL de votre
choix, avec un payload JSON détaillé.
Cas d'usage
-
Automatisation CI/CD :
Déclencher un build quand une note de
procédure est mise à jour
-
Synchronisation : Copier
les nouveaux fichiers vers un autre système
(SharePoint, Google Drive)
-
Notifications : Alerter un
canal Slack/Discord quand un document est
créé
-
Audit externe : Logger
toutes les modifications dans une base de
données externe
-
Déploiement : Publier un
article de blog quand un fichier est marqué
publish: true
Événements supportés
|
Événement
|
Déclencheur
|
Données
|
file_created
|
Création via l'API ou la palette
|
vault,
path
|
file_deleted
|
Suppression via l'API ou l'éditeur
|
vault,
path
|
file_renamed
|
Renommage via l'API
|
vault,
old_path,
new_path
|
directory_created
|
Création de dossier via l'API
|
vault,
path
|
directory_deleted
|
Suppression de dossier via l'API
|
vault,
path
|
directory_renamed
|
Renommage de dossier via l'API
|
vault,
old_path,
new_path
|
Note : l'événement
file_modified est réservé pour
usage futur. Les modifications de contenu
via l'éditeur ne déclenchent pas encore de
webhook.
Format du payload
Chaque webhook reçoit un POST avec
Content-Type: application/json :
{
"event": "file_created",
"timestamp": "2026-06-03T14:30:00.123456+00:00",
"data": {
"vault": "IT",
"path": "procedures/deploiement.md"
}
}
Sécurité : signature HMAC-SHA256
Si vous configurez un secret, chaque requête
inclut un header
X-ObsiGate-Signature :
X-ObsiGate-Signature: sha256=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
Pour vérifier côté récepteur : calculez
HMAC-SHA256(corps_brut, secret) et
comparez. Le header
X-ObsiGate-Event contient aussi le
type d'événement pour un routage rapide.
Configuration
Les webhooks se gèrent dans le modal
Configurations (⚙️ menu
Options), section Webhooks. Réservé aux
administrateurs.
-
Allez dans ⚙️ Configurations → onglet
Webhooks
-
Remplissez :
Nom (descriptif),
URL (endpoint cible),
Secret (optionnel)
- Cochez les événements à écouter
- Cliquez Ajouter
Les webhooks peuvent être activés/désactivés,
modifiés ou supprimés à tout moment. Le
last_fired_at indique la dernière
exécution.
Exemples concrets
Récepteur Python (Flask)
from flask import Flask, request\nimport hmac, hashlib\n\napp = Flask(__name__)\nWEBHOOK_SECRET = "mon-secret" # même que dans ObsiGate\n\n@app.route("/webhook", methods=["POST"])\ndef webhook():\n # Vérifier la signature\n signature = request.headers.get("X-ObsiGate-Signature", "")\n body = request.get_data()\n expected = "sha256=" + hmac.new(\n WEBHOOK_SECRET.encode(), body, hashlib.sha256\n ).hexdigest()\n if not hmac.compare_digest(signature, expected):\n return "Invalid signature", 403\n\n payload = request.get_json()\n print(f"Événement: {payload['event']}")\n print(f"Fichier: {payload['data']['vault']}/{payload['data']['path']}")\n return "OK", 200\n\napp.run(port=5000)
n8n / Make (no-code)
-
Créez un
Webhook Trigger dans n8n ou
Make
-
Copiez l'URL générée (ex:
https://n8n.monserveur.com/webhook/abc123)
-
Dans ObsiGate, ajoutez un webhook pointant
vers cette URL
- Sélectionnez les événements souhaités
-
Le workflow se déclenche automatiquement à
chaque événement
Notification Discord
Utilisez un webhook relais (n8n, Make, ou un
script) pour transformer le payload ObsiGate en
message Discord :
# Exemple avec curl + jq dans un script bash
WEBHOOK_URL="https://discord.com/api/webhooks/..."
OBSIGATE_SECRET="mon-secret"
# Lire le payload depuis stdin
read -r payload
event=$(echo "$payload" | jq -r '.event')
path=$(echo "$payload" | jq -r '.data.path')
curl -H "Content-Type: application/json" -d "{
\"content\": \"📝 **$event** — $path\"
}" "$WEBHOOK_URL"
Tester avec curl
# Simuler ce qu'ObsiGate envoie (pour tester votre endpoint)
curl -X POST https://votre-serveur.com/webhook \
-H "Content-Type: application/json" \
-H "X-ObsiGate-Event: file_created" \
-H "X-ObsiGate-Signature: sha256=$(echo -n '{"event":"file_created",...}' | openssl dgst -sha256 -hmac 'mon-secret' | cut -d' ' -f2)" \
-d '{"event":"file_created","timestamp":"2026-06-03T14:30:00Z","data":{"vault":"IT","path":"notes/test.md"}}'
Limitations actuelles
-
Timeout de 5 secondes par
requête — les webhooks sont "fire and
forget" (pas de retry)
-
Les modifications détectées par le watcher
filesystem (watchdog)
ne déclenchent pas de
webhooks — seules les opérations via l'API
REST sont prises en compte
-
file_modified n'est pas encore
dispatché (réservé pour version future)
- Pas de retry automatique en cas d'échec
-
Pas de filtrage par vault — un webhook
écoute toutes les vaults
💾 Sauvegardes et Audits
Backup automatique
ObsiGate crée automatiquement des sauvegardes
avant chaque modification destructive.
-
Avant écriture : Sauvegarde
du contenu original dans
.obsigate-backup/
-
Timestamp : Chaque backup
est horodaté
-
Répertoire dédié :
.obsigate-backup/ dans le
répertoire de la vault
Audit log
Toutes les opérations sensibles sont tracées
dans un journal.
-
Journal : Fichier
data/audit.log au format JSON
lines
-
Événements tracés :
Écritures, suppressions, changements de
configuration
-
Rotation : Rotation
automatique à 10 Mo
🛡️ Sécurité
Authentification
-
JWT + Argon2id : Tokens JWT
avec mots de passe hachés Argon2id
-
Contrôle d'accès par vault
: Chaque utilisateur voit uniquement ses
vaults
-
Refresh tokens : Cookies
HttpOnly avec rotation automatique
-
Rate limiting : 10
tentatives / 15 min par IP + verrouillage
compte
-
Compte admin : Créé
automatiquement au premier démarrage
Protection
-
Secret redactor : Masque
JWT, clés API, tokens GitHub dans les
aperçus
-
Path traversal : Validation
des chemins contre les attaques
../
-
Headers CSP :
Content-Security-Policy, X-Frame-Options,
XSS-Protection
-
Atomic writes : Écriture
via fichier temporaire + renommage atomique
-
Non-root Docker : Conteneur
tourne avec UID 1000
MFA : TOTP, WebAuthn, codes de secours
Activez la double authentification dans Réglages → Profil : applications TOTP (Authy, Aegis…), clés de sécurité et passkeys (WebAuthn, y compris Windows Hello) et 10 codes de secours à conserver hors ligne. Chaque méthode s'active et se désactive indépendamment.
Tableau de bord administrateur
Le rôle admin ouvre une page dédiée /admin.html (bouton du menu Options) : statut du serveur en direct, utilisateurs, vaults, sessions actives et journal d'audit. Le CRUD utilisateurs est aussi disponible dans les Configurations.
💡 Astuces et bonnes pratiques
Workflow recommandé
-
Sélectionnez un contexte :
Choisissez un vault pour réduire le bruit
-
Explorez l'arborescence :
Naviguez dans les dossiers
-
Utilisez les tags : Filtrez
par tags pour affiner
-
Recherchez intelligemment :
Combinez opérateurs et texte libre
-
Profitez de l'historique :
Réutilisez vos recherches fréquentes
Optimisations
-
Masquez la sidebar : Plus
d'espace pour le contenu
-
Utilisez le filtrage sidebar
: Plus rapide que la recherche globale pour
trouver un fichier
-
Favorisez les opérateurs :
tag: et
vault: accélèrent la recherche
-
Breadcrumb cliquable :
Repositionnez rapidement la sidebar
Trucs et astuces
-
Navigation visuelle : Le
breadcrumb repositionne automatiquement la
sidebar
-
Gestion de l'espace :
Réduisez les sections Vaults/Tags selon vos
besoins
-
Confort de lecture :
Ajustez la largeur de la sidebar
-
Mobile-friendly : Utilisez
le bouton hamburger sur mobile
-
Wikilinks : Naviguez entre
notes comme dans Obsidian
-
Images : Support complet
des syntaxes Obsidian
Cas d'usage avancés
-
Recherche multi-critères :
tag:docker tag:linux vault:IT
nginx
-
Exploration par tags :
Cliquez sur un tag dans une note pour voir
toutes les notes similaires
-
Édition rapide : Ouvrez
l'éditeur, modifiez, sauvegardez
-
Export : Téléchargez des
fichiers pour backup ou partage
-
Multi-fenêtres : Ouvrez
plusieurs notes dans des onglets séparés
🔌 API
ObsiGate expose une API REST couvrant toute l'application (vaults, fichiers, recherche, backups, export, IA, partage, admin), documentée en OpenAPI 3.1 :
/docs — interface Swagger UI pour essayer les requêtes en direct./redoc — référence alternative plus compacte./api — page de garde regroupant les endpoints par catégorie./openapi.json — le schéma machine, à importer dans Postman ou Insomnia.
Authentification
Connectez-vous via POST /api/auth/login pour obtenir un token Bearer (le même jeton est accepté en cookie HttpOnly, ce qui permet aux clients navigateur d'utiliser credentials: "include"). Toutes les routes /api/* exigent ce jeton sauf mention contraire.
Serveur MCP
Les outils de l'assistant IA (lire, lister, chercher, ouvrir, écrire…) sont exposés à tout client MCP (Claude Desktop, Cursor, Cline…) sur https://votre-instance/mcp avec un token d'API. Configuration et exemples : docs/MCP_GUIDE.md.
Automatisation
Pour automatiser depuis l'extérieur : GET /api/search?q=… et GET /api/file/{vault}?path=… permettent d'indexer ou relire vos notes dans un autre outil ; les webhooks sortants (section 🪝) évitent le polling.
🌍 Multilingue
- L'interface est intégralement bilingue français / anglais. Réglages → Profil → Langue : le choix est enregistré sur votre compte et vous suit sur tous les appareils.
- Tout est traduit : menus, messages, notifications, et le présent guide. Les réponses de l'assistant IA suivent la langue de vos documents.
- Les boutons Markdown / PDF de ce guide téléchargent la version dans votre langue.
🧩 Plugins
Les plugins étendent ObsiGate : affichage personnalisé des
fichiers, filtres de recherche, actions d'édition, widgets
et intégrations. Ils s'exécutent dans des Web Workers
sandboxés — isolés de la page pour la sécurité.
Installation
- Ouvrez Réglages → 🧩 Plugins.
- Cliquez « Installer un plugin ».
- Sélectionnez un fichier
.zip contenant le manifest
plugin.json + le code du plugin.
- Le manifest est validé (nom, version semver, hooks, permissions)
avant installation.
Gestion
- Activer / Désactiver : boutons sur chaque plugin — les
hooks ne tournent que si le plugin est activé.
- Désinstaller : supprime définitivement le plugin du vault.
- Code : visualisez le code source du plugin installé.
Développer un plugin
Téléchargez le modèle depuis Réglages → Plugins → « Obtenir le
modèle ». Un plugin se compose d'un manifest
plugin.json et d'un fichier principal (ex.
index.js).
Hooks disponibles
- onFileRender :
transforme le contenu affiché d'un fichier.
- onSearchFilter :
filtre les résultats de recherche.
- onEditorAction :
intercepte les actions de l'éditeur.
- onSidebarItem :
ajoute des éléments à la barre latérale.
- onFileCreate / onFileDelete :
réagit à la création / suppression de fichiers.
- onVaultMount :
exécuté au chargement d'un vault.
Sécurité
- Sandbox Web Worker : le code plugin tourne isolé, sans
accès direct au DOM.
- Permissions : chaque hook déclaré doit être satisfait
par les permissions du manifest.
- Empaquetage sécurisé : le .zip est vérifié contre le
path traversal à l'installation.
- Admin uniquement : l'installation et la suppression
requièrent le rôle admin.