MCP Obsidian Docker

🚀 MCP Obsidian Docker 版本

這是 MCP Obsidian 的容器化版本。MCP Obsidian 是一個服務器，可通過社區插件 Local REST API 與 Obsidian 進行交互，為 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 密鑰”字段，該字段中的內容即為你的身份驗證密鑰。

設置 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 密鑰設置正確。

常見問題

💡 使用建議

• 認證失敗：請再次檢查你在 Obsidian 插件設置和 .env 文件中的 API 密鑰是否一致。
• 連接被拒絕：請確保 Obsidian 正在運行且 Local REST API 插件已啟用。
• 端口衝突：如果端口 27124 已經被佔用，你可以修改 docker-compose.yml 中的端口映射。

📚 詳細文檔

日誌

日誌存儲在 ./logs 目錄中，該目錄作為卷已掛載到容器中。

環境變量

📄 許可證

此項目遵循 MIT 許可證 - 有關詳細信息，請參閱原始 MCP Obsidian 倉庫。