跳转到内容
Engram Docs

快速开始

Engram 是为你的 Markdown 笔记提供实时同步、语义搜索和 AI 访问能力的一层服务。笔记始终以普通 .md 文件的形式归你所有。你可以搭配 Obsidian 获得最完整的记录体验，也可以完全使用 Engram 网页应用和 Claude 之类的 AI 助手。你的知识库会在它们之间同步，MCP 端点则让 AI 工具在你授权的前提下读取和更新你的笔记。

整体结构

Section titled “整体结构”
┌──────────────────────┐         ┌──────────────────────┐
│  Obsidian            │ ◄────►  │  Engram backend      │
│  + Engram plugin     │  sync   │  (Elixir / Phoenix)  │
└──────────────────────┘         └──────────┬───────────┘
                                            │
   ┌────────────────────────────────────────┤
   │                                        │
   ▼                                        ▼
┌──────────────────┐               ┌──────────────────┐
│  Web app         │               │  AI assistants   │
│  (browser)       │               │  via MCP         │
└──────────────────┘               └──────────────────┘

三种入口，共用同一份知识库数据：

  • Obsidian 插件是主要的记录入口。笔记在 Obsidian 中编写，并实时同步到后端。
  • 网页应用位于 app.engram.page。可在任意浏览器中浏览、搜索和编辑你的知识库，对 wikilink、嵌入、KaTeX 和 Mermaid 的渲染效果与 Obsidian 一致。
  • MCP 端点可连接 Claude、Cursor、ChatGPT 等能访问你知识库的 AI 助手。你的笔记会以工具调用的方式供它们使用。

云端还是自托管

Section titled “云端还是自托管”

Engram 既可以作为托管服务使用，也可以运行在你自己的基础设施上。选择你想站的那一边：

云端自托管
运行位置app.engram.page你的服务器（Docker）
运维由我们托管由你负责
嵌入模型Voyage AI（托管）Ollama（本地）或自带
存储AWS S3MinIO / 你自己的 S3
计费通过 Paddle 订阅免费，只需承担你自己的硬件成本
许可适用我们的服务条款PolyForm Small Business 1.0.0
适合只想开箱即用数据主权、大型知识库、实验环境

两边使用的插件相同，只需把它指向不同的后端 URL。无论如何，知识库的内容都保存在 Obsidian 里，所以切换只需重新指定插件的后端，再把知识库重新推送一遍。云端与自托管之间的自动导出/导入工具已在路线图上；目前只能手动完成（从 Obsidian 推送到你要迁往的一方）。

云端快速上手

Section titled “云端快速上手”

共五步，大约五分钟：

  1. 在 app.engram.page 注册，并完成引导向导（接受条款、选择套餐）。
  2. 在 Obsidian 中安装 Engram Vault Sync 插件。打开“设置 → 第三方插件 → 浏览”并搜索 Engram Vault Sync，或直接打开插件页面：community.obsidian.md/plugins/engram-vault-sync。
  3. 让插件登录你的 Engram 账号。插件会打开一个 OAuth 窗口，批准即可。
  4. 选择要同步的知识库。Engram 会先推送初始快照，之后保持实时同步。
  5. **搜索并使用。**在网页应用或命令面板中试试语义搜索。你可以在 Obsidian、网页应用以及（配置完成后）MCP 客户端中访问这些笔记。

自托管快速上手

Section titled “自托管快速上手”

如果你想在自己的服务器上运行 Engram，请前往自托管。简单来说：拉取 Docker Compose 配置，设置几个环境变量，运行 docker compose up。完整指南涵盖环境配置、加密设置、备份和升级路径。

连接 AI 助手

Section titled “连接 AI 助手”

知识库开始同步后，把它接入 Claude Desktop（或任何 MCP 客户端），你的笔记就能作为可搜索、可写入的工具被调用。各客户端的设置请见 AI 集成，协议层面的背景请见 AI / MCP。

接下来

Section titled “接下来”