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
🧭 Interface utilisateur
En-tête
La barre supérieure contient les éléments essentiels :
- Bouton menu hamburger (mobile) : 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
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
🗺️ 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 tagvault:IT : Rechercher dans un vault spécifiquetitle:kubernetes : Chercher dans les titres uniquementpath:recettes/soupes : Filtrer par cheminext: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
📄 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
- Autres : .txt, .log, .sql, .csv
✏️ É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)
🗺️ 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
Performance
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
⌨️ 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 suggestionsEnter : Sélectionner la suggestion active ou lancer la rechercheEscape : Fermer le dropdown de suggestions
Interface
Ctrl+T : Basculer le thème clair/sombreCtrl+Shift+Espace : Palette de fichiersCtrl+Alt+Espace : Palette de commandesEscape : Fermer la palette / les suggestions
Onglets
Ctrl+W : Fermer l'onglet actifCtrl+Tab : Onglet suivantCtrl+Shift+Tab : Onglet précédent
Éditeur CodeMirror
Ctrl+F : Rechercher dans le fichierCtrl+Z : AnnulerCtrl+Y : RefaireCtrl+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
🔗 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 notifient des services externes lors des changements de fichiers.
- Événements : Création, modification, suppression, renommage
- Format : POST JSON avec détails complets de l'événement
- Signature HMAC-SHA256 : Optionnelle pour vérifier l'origine
- Configuration : Gestion via le modal Configurations
💾 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
💡 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