Obsidian Vault API — Docker

Versión compatible con Docker de Obsidian Vault API. Expone tu bóveda de Obsidian como un servidor MCP, sin necesidad de la aplicación de escritorio de Obsidian. Funciona 24/7 en cualquier servidor o NAS.

El plugin original se ejecuta dentro de Obsidian y utiliza la API de Obsidian + el Canvas de Electron para el procesamiento de imágenes. Esta versión se ejecuta como un proceso independiente de Node.js en Docker, usando operaciones directas de fs y sharp para redimensionar imágenes. Se conservan las 13 herramientas MCP del original.

Inicio rápido

docker-compose (recomendado)

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

Interfaz web

Tras iniciar el contenedor, abre tu navegador y ve a:

http://localhost:2768/

El panel te permite:

• Ver el estado del servidor (en ejecución/detenido, puerto, nombre de la bóveda)

• Editar la configuración (puerto, dirección de enlace, comandos permitidos) — los cambios se guardan en /data/config.json y persisten entre reinicios

• Regenerar la clave API — genera un nuevo secreto, requiere reconectar los clientes

• Reiniciar / Detener el servidor MCP sin detener el contenedor

• Copiar información de conexión — URL SSE, configuración JSON de Claude Desktop, clave API

La interfaz web en sí no requiere autenticación (es la página de configuración). Los endpoints MCP (/sse, /message, /raw) requieren la clave API.

Configuración

La configuración se almacena en /data/config.json y persiste entre reinicios del contenedor. Las variables de entorno actúan como anulaciones iniciales en el primer arranque; a partir de entonces, el archivo de configuración es la fuente de verdad.

Conexión de tu cliente de IA

LM Studio / Open WebUI / Cualquier cliente MCP con soporte SSE

Añade la URL del servidor MCP:

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

Claude Desktop

Añade a claude_desktop_config.json:

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

O copia el JSON directamente desde el panel de la interfaz web.

Autenticación

O bien:

• Parámetro de consulta: ?key=YOUR_API_KEY

• Encabezado HTTP: X-Api-Key: YOUR_API_KEY

Herramientas disponibles

Soporte de imágenes

Las imágenes grandes se redimensionan automáticamente con sharp (Node.js puro, sin Electron):

NFS / Montajes de red

El servidor lee los archivos directamente del sistema de archivos en cada llamada de herramienta, sin caché. Los montajes NFS funcionan en tiempo real:

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

Comprobación de salud

curl http://localhost:2768/health

Devuelve { "status": "ok", "version": "1.1.0" } públicamente. Las solicitudes autenticadas también devuelven vault, port y sessions.

Compilación desde el código fuente

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

O sin Docker:

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

Diferencias con respecto al plugin original

Licencia

CC BY-NC-SA 4.0 — igual que el proyecto original.