Obsidian Vault API — Docker

Obsidian Vault API の Docker 互換バージョン。Obsidian の vault を MCP サーバーとして公開します — Obsidian デスクトップアプリは不要です。任意のサーバーや NAS で 24 時間 365 日稼働します。

元のプラグインは Obsidian 内で動作し、画像処理に Obsidian API + Electron の Canvas を使用します。このバージョンは Docker 内のスタンドアロン Node.js プロセスとして動作し、直接の 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

Web UI

コンテナを起動したら、ブラウザを開いて次の URL にアクセスしてください:

http://localhost:2768/

ダッシュボードでは以下の操作ができます:

• サーバーステータスの表示 (実行中/停止中、ポート、vault 名)

• 設定の編集 (ポート、バインドアドレス、許可コマンド) — 変更は /data/config.json に保存され、再起動後も保持されます

• API キーの再生成 — 新しいシークレットを生成します。クライアントの再接続が必要です

• 再起動 / 停止 — コンテナを停止せずに MCP サーバーを再起動・停止

• 接続情報のコピー — SSE URL、Claude Desktop の JSON 設定、API キー

Web UI 自体は認証を必要としません (設定ページのため)。MCP エンドポイント (/sse、/message、/raw) には API キーが必要です。

設定

設定は /data/config.json に保存され、コンテナの再起動後も保持されます。環境変数は初回起動時の初期オーバーライドとして機能します — 以降は設定ファイルが正となります。

AI クライアントへの接続

LM Studio / Open WebUI / SSE 対応の MCP クライアント

MCP サーバー URL を追加:

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"
    }
  }
}

または、Web UI ダッシュボードから 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 — 元のプロジェクトと同じです。