金大哥 - mcp-obsidian-docker MCP 详情

article

README

🚀 MCP Obsidian Docker 版本

这是 MCP Obsidian 的容器化版本。MCP Obsidian 是一个服务器，可通过 Obsidian 的社区插件 Local REST API 与之进行交互，为 Obsidian 的使用提供了更多便利。

🚀 快速开始

先决条件

已安装 Docker 和 Docker Compose。
安装了 Local REST API 插件并完成配置的 Obsidian。
从 Local REST API 插件获取的 API 密钥。

设置步骤

克隆此仓库。
按照后续说明配置 API 密钥。
构建并启动容器：

docker-compose up -d

✨ 主要特性

容器化部署，方便快捷，易于管理。
通过 API 密钥进行身份验证，保障数据安全。
日志存储在本地，便于问题排查和监控。

📦 安装指南

API 密钥配置

获取你的 API 密钥

打开 Obsidian。
点击底部左侧的齿轮图标进入设置。
在左侧边栏选择“社区插件”。
在已安装的插件列表中找到“Local REST API”。
点击插件旁边的设置齿轮图标（⚙️）。
查找“API 密钥”字段，该字段的值即为你的身份验证密钥。

设置 API 密钥

通过复制示例文件创建环境文件：

cp .env.example .env

编辑 .env 文件：

# 使用你喜欢的编辑器打开
nano .env
# 或者
vim .env
# 或任何文本编辑器

将占位符替换为你的实际 API 密钥：

# 在之前：
OBSIDIAN_API_KEY=your_api_key_here

# 修改后（示例 - 使用你的实际密钥）：
OBSIDIAN_API_KEY=1234abcd5678efgh

安全注意事项

.env 文件已列入 .gitignore 以防止意外提交。
绝对不要分享你的 API 密钥或将其提交到版本控制中。
如果需要更改你的 API 密钥：
1. 在 Obsidian 中生成新的密钥。
2. 更新你的 .env 文件。
3. 重启容器：docker-compose restart

💻 使用示例

验证设置

检查容器是否在运行：

docker-compose ps

查看日志以查找任何问题：

docker-compose logs -f

如果看到身份验证错误，请确认 .env 文件中你的 API 密钥设置正确。

常见问题

认证失败：请再次检查你在 Obsidian 插件设置和 .env 文件中的 API 密钥是否一致。
连接被拒绝：请确保 Obsidian 正在运行且 Local REST API 插件已启用。
端口冲突：如果端口 27124 已经被占用，你可以修改 docker-compose.yml 中的端口映射。

📚 详细文档

日志

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

环境变量

| 属性 | 详情 | |------|------| | 环境变量 | 详情 | | OBSIDIAN_API_KEY | 你的 Obsidian Local REST API 插件 API 密钥（必需） |

📄 许可证

此项目遵循 MIT 许可证 - 有关详细信息，请参阅原始 MCP Obsidian 仓库。

mcp-obsidian-docker