MCP Obsidian Docker

🚀 MCP Obsidian Docker 版本

このプロジェクトは、MCP Obsidian のコンテナ化バージョンです。MCP Obsidian は、Obsidian のコミュニティプラグイン Local REST API を通じて相互作用するサーバーです。

🚀 クイックスタート

このセクションでは、MCP Obsidian Docker バージョンをセットアップして使用するための手順を説明します。

✨ 主な機能

• Obsidian と Local REST API プラグインを通じて相互作用するコンテナ化サーバー
• Docker と Docker Compose を使用した簡単なセットアップ
• 安全な API キー管理

📦 インストール

前提条件

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 キー」フィールドを探し、これが認証キーです。

API キーの設定

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

   cp .env.example .env
   

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

   # 好みのエディタで開く
   nano .env
   # または
   vim .env
   # または他のテキストエディタ
   

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

   # 変更前
   OBSIDIAN_API_KEY=your_api_key_here
   
   # 変更後（例 - 実際のキーを使用）
   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 ライセンスの下でライセンスされています。詳細については、元の MCP Obsidian リポジトリ を参照してください。