MCP Obsidian Docker

MCP Obsidian Docker

这是 MCP Obsidian 的容器化版本。它是一个通过 Local REST API 社区插件与 Obsidian 交互的服务。

前提条件

1. 已安装 Docker 和 Docker Compose
2. 已安装并配置 Obsidian 和 Local REST API 插件
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 仓库。