Obsidian Docker服务

MCP黑曜石Docker

这是一个容器化版本的 MCP黑曜石，一个通过本地REST API社区插件与Obsidian交互的服务器。

先决条件

1. 已安装Docker和Docker Compose
2. 黑曜石与 本地REST API插件 已安装并配置
3. 本地REST API插件的API密钥

API密钥配置

获取API密钥

1. 开放式黑曜石
2. 转到设置（左下角的齿轮图标）
3. 在左侧边栏中选择“社区插件”
4. 在已安装的插件列表中查找“本地REST API”
5. 点击设置齿轮图标(⚙️) 插件旁边
6. 查找“API密钥”字段-这是您的身份验证密钥

设置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. 在黑曜石中生成新密钥
  2. 更新您的 .env 文件
  3. 重新启动容器： docker-compose restart

设置

1. 克隆此存储库
2. 如上所述配置API密钥
3. 构建并启动容器：
   复制

   docker-compose up -d
   

用法

MCP黑曜石服务器将在端口27124可用。请确保此端口与您的Obsidian本地REST API插件中配置的端口匹配。

验证设置

1. 检查容器是否正在运行：

   复制

   docker-compose ps
   

2. 检查日志是否有任何问题：

   复制

   docker-compose logs -f
   

3. 如果您看到身份验证错误，请验证您的API密钥在 .env 文件

常见问题

1. 认证失败：在Obsidian插件设置和 .env 文件
2. 连接被拒绝：确保Obsidian正在运行并且本地REST API插件已启用
3. 端口冲突：如果端口27124已在使用中，您可以在中修改端口映射 docker-compose.yml

日志

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

环境变量

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

许可证

此项目根据MIT许可证获得许可-请参阅原始 MCP黑曜石储存库 了解详情。