Obsidian Vault API — Docker

Docker-kompatible Version von Obsidian Vault API. Stellt Ihren Obsidian-Vault als MCP-Server bereit – keine Obsidian-Desktop-App erforderlich. Läuft 24/7 auf jedem Server oder NAS.

Das ursprüngliche Plugin läuft in Obsidian und nutzt die Obsidian-API + die Canvas-API von Electron zur Bildverarbeitung. Diese Version läuft als eigenständiger Node.js-Prozess in Docker und verwendet direkte fs-Operationen sowie sharp zum Ändern der Bildgröße. Alle 13 MCP-Tools des Originals bleiben erhalten.

Schnellstart

docker-compose (empfohlen)

services:
  vault-api:
    build: .
    container_name: obsidian-vault-api
    restart: unless-stopped
    ports:
      - "2768:2768"
    volumes:
      - /path/to/your/vault:/vault
      - vault-api-data:/data
    environment:
      - VAULT_API_KEY=your-secret-key-here

volumes:
  vault-api-data:

docker compose up -d

docker run

docker run -d \
  --name obsidian-vault-api \
  -p 2768:2768 \
  -v /path/to/your/vault:/vault \
  -v vault-api-data:/data \
  -e VAULT_API_KEY=your-secret-key-here \
  ghcr.io/alexandre1116/obsidian-vault-api-docker:latest

Web-UI

Nach dem Starten des Containers öffnen Sie Ihren Browser und gehen Sie zu:

http://localhost:2768/

Das Dashboard ermöglicht Ihnen:

• Serverstatus anzeigen (läuft/gestoppt, Port, Vault-Name)

• Konfiguration bearbeiten (Port, Bind-Adresse, erlaubte Befehle) — Änderungen werden in /data/config.json gespeichert und bleiben über Neustarts hinweg erhalten

• API-Schlüssel neu generieren — erzeugt ein neues Geheimnis; Clients müssen sich neu verbinden

• MCP-Server neu starten / stoppen, ohne den Container zu stoppen

• Verbindungsinformationen kopieren — SSE-URL, Claude Desktop JSON-Konfiguration, API-Schlüssel

Die Web-UI selbst erfordert keine Authentifizierung (es ist die Konfigurationsseite). Die MCP-Endpunkte (/sse, /message, /raw) erfordern den API-Schlüssel.

Konfiguration

Die Konfiguration wird in /data/config.json gespeichert und bleibt über Container-Neustarts hinweg erhalten. Umgebungsvariablen dienen beim ersten Start als anfängliche Überschreibungen – danach ist die Konfigurationsdatei die maßgebliche Quelle.

Ihren KI-Client verbinden

LM Studio / Open WebUI / Jeder MCP-Client mit SSE-Unterstützung

Fügen Sie die MCP-Server-URL hinzu:

http://localhost:2768/sse?key=YOUR_API_KEY

Claude Desktop

Fügen Sie Folgendes zu claude_desktop_config.json hinzu:

{
  "mcpServers": {
    "obsidian": {
      "url": "http://localhost:2768/sse?key=YOUR_API_KEY"
    }
  }
}

Oder kopieren Sie das JSON direkt aus dem Web-UI-Dashboard.

Authentifizierung

Entweder:

• Query-Parameter: ?key=YOUR_API_KEY

• HTTP-Header: X-Api-Key: YOUR_API_KEY

Verfügbare Tools

Bildunterstützung

Große Bilder werden automatisch mit sharp in der Größe angepasst (reines Node.js, kein Electron):

NFS / Netzwerk-Mounts

Der Server liest Dateien bei jedem Tool-Aufruf frisch vom Dateisystem – kein Caching. NFS-Mounts funktionieren in Echtzeit:

volumes:
  - nfs-vault:/vault

volumes:
  nfs-vault:
    driver: local
    driver_opts:
      type: nfs
      device: ":/path/on/nfs"
      o: addr=10.0.0.1,nfsvers=4

Gesundheitscheck

curl http://localhost:2768/health

Gibt öffentlich { "status": "ok", "version": "1.1.0" } zurück. Authentifizierte Anfragen geben zusätzlich vault, port und sessions zurück.

Aus dem Quellcode erstellen

git clone https://github.com/Alexandre1116/Obsidian-Vault-API-Docker
cd Obsidian-Vault-API-Docker
docker compose build
docker compose up -d

Oder ohne Docker:

npm install
npm run build
VAULT_PATH=/path/to/vault VAULT_API_KEY=secret npm start

Unterschiede zum ursprünglichen Plugin

Lizenz

CC BY-NC-SA 4.0 — wie beim ursprünglichen Projekt.