Obsidian Vault API — Docker

Docker-совместимая версия Obsidian Vault API. Предоставляет доступ к вашему хранилищу Obsidian как MCP-сервер — без необходимости в десктопном приложении Obsidian. Работает круглосуточно на любом сервере или NAS.

Оригинальный плагин работает внутри Obsidian и использует Obsidian API + Canvas из Electron для обработки изображений. Эта версия работает как отдельный процесс Node.js в Docker, используя прямые операции fs и sharp для изменения размера изображений. Все 13 MCP-инструментов из оригинала сохранены.

Быстрый старт

docker-compose (рекомендуется)

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

Веб-интерфейс

После запуска контейнера откройте браузер и перейдите по адресу:

http://localhost:2768/

Панель управления позволяет:

• Просматривать статус сервера (запущен/остановлен, порт, имя хранилища)

• Изменять конфигурацию (порт, адрес привязки, разрешённые команды) — изменения сохраняются в /data/config.json и сохраняются между перезапусками

• Перегенерировать API-ключ — создаёт новый секрет, требует переподключения клиентов

• Перезапускать / останавливать MCP-сервер без остановки контейнера

• Копировать информацию для подключения — SSE URL, JSON-конфигурация Claude Desktop, API-ключ

Сам веб-интерфейс не требует аутентификации (это страница конфигурации). MCP-эндпоинты (/sse, /message, /raw) требуют API-ключ.

Конфигурация

Конфигурация хранится в /data/config.json и сохраняется между перезапусками контейнера. Переменные окружения действуют как первоначальные переопределения при первом запуске — после этого файл конфигурации является источником истины.

Подключение вашего AI-клиента

LM Studio / Open WebUI / любой MCP-клиент с поддержкой SSE

Добавьте URL MCP-сервера:

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

Claude Desktop

Добавьте в claude_desktop_config.json:

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

Или скопируйте JSON напрямую из панели веб-интерфейса.

Аутентификация

Либо:

• Параметр запроса: ?key=YOUR_API_KEY

• HTTP-заголовок: X-Api-Key: YOUR_API_KEY

Доступные инструменты

Поддержка изображений

Большие изображения автоматически изменяются с помощью sharp (чистый Node.js, без Electron):

NFS / Сетевые монтирования

Сервер читает файлы напрямую из файловой системы при каждом вызове инструмента — без кэширования. NFS-монтирования работают в реальном времени:

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

Проверка состояния

curl http://localhost:2768/health

Публично возвращает { "status": "ok", "version": "1.1.0" }. Аутентифицированные запросы также возвращают vault, port и sessions.

Сборка из исходников

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

Или без Docker:

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

Отличия от оригинального плагина

Лицензия

CC BY-NC-SA 4.0 — та же, что и у оригинального проекта.