MCP Obsidian Docker

这是一个 MCP Obsidian 的容器化版本，它是一个通过 Local REST API 社区插件与 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. 如果您看到身份验证错误，请验证您的 API 密钥是否在 .env 文件中正确设置

常见问题

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 存储库。