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. 身份验证失败：请再次检查您的API密钥在Obsidian插件设置和.env文件中的设置
2. 连接被拒绝：确保Obsidian正在运行且Local REST API插件已启用
3. 端口冲突：如果端口27124已被占用，可以在docker-compose.yml中修改端口映射

日志

日志存储在./logs目录中，该目录作为卷挂载在容器中。

环境变量

• OBSIDIAN_API_KEY：您的Obsidian Local REST API插件API密钥（必需）

许可证

本项目根据MIT许可证发布 - 详情请参阅原始MCP Obsidian仓库。 </中文翻译>