MCP Obsidian Docker

MCP Obsidian Docker

これは、Local REST API コミュニティプラグインを介して Obsidian と連携するサーバー、MCP Obsidian のコンテナ化バージョンです。

前提条件

1. Docker と Docker Compose がインストールされていること
2. Local REST API プラグイン がインストールされ、設定された Obsidian
3. Local REST API プラグインの API キー

API キーの設定

API キーの取得

1. Obsidian を開きます
2. 設定（左下の歯車アイコン）に移動します
3. 左側のサイドバーで「コミュニティプラグイン」を選択します
4. インストール済みプラグインの一覧から「Local REST API」を見つけます
5. プラグインの横にある設定の歯車アイコン（⚙️）をクリックします
6. 「API Key」欄を確認します。これが認証キーです

API キーの設定方法

1. サンプルをコピーして環境ファイルを作成します：

   cp .env.example .env
   

2. .env ファイルを編集します：

   # Open with your preferred editor
   nano .env
   # or
   vim .env
   # or any text editor
   

3. プレースホルダーを実際の API キーに置き換えます：

   # Before:
   OBSIDIAN_API_KEY=your_api_key_here
   
   # After (example - use your actual key):
   OBSIDIAN_API_KEY=1234abcd5678efgh
   

セキュリティに関する注意

• .env ファイルは、誤ってコミットされないよう .gitignore に記載されています
• API キーを共有したり、バージョン管理にコミットしたりしないでください
• API キーを変更する必要がある場合：
  1. Obsidian で新しいキーを生成します
  2. .env ファイルを更新します
  3. コンテナを再起動します：docker-compose restart

セットアップ

1. このリポジトリをクローンします
2. 上記の説明に従って API キーを設定します
3. コンテナをビルドして起動します：

   docker-compose up -d
   

使用方法

MCP Obsidian サーバーはポート 27124 で利用できます。このポートが Obsidian Local REST API プラグインで設定したポートと一致していることを確認してください。

セットアップの確認

1. コンテナが実行中か確認します：

   docker-compose ps
   

2. ログで問題がないか確認します：

   docker-compose logs -f
   

3. 認証エラーが表示された場合は、.env ファイルに API キーが正しく設定されていることを確認してください

よくある問題

1. 認証に失敗する：Obsidian プラグインの設定と .env ファイルの両方で、API キーを再確認してください
2. 接続が拒否される：Obsidian が起動しており、Local REST API プラグインが有効になっていることを確認してください
3. ポートの競合：ポート 27124 がすでに使用されている場合は、docker-compose.yml のポートマッピングを変更できます

ログ

ログは ./logs ディレクトリに保存されます。このディレクトリはコンテナ内でボリュームとしてマウントされています。

環境変数

• OBSIDIAN_API_KEY：Obsidian Local REST API プラグインの API キー（必須）

ライセンス

このプロジェクトは MIT License の下でライセンスされています。詳細については、元の MCP Obsidian リポジトリを参照してください。