跳到內容
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
適合只想讓它能用資料主權、大型知識庫、實驗室使用

兩邊使用的外掛相同，只要把它指向不同的後端網址即可。知識庫內容始終存放 在 Obsidian 中，所以換邊只需要重新指定外掛的目標並重新推送知識庫。雲端 ↔ 自行架設的自動匯出／匯入工具已列入規劃；目前仍需手動操作（從 Obsidian 推送到你要遷移的那一邊）。

雲端快速入門

Section titled “雲端快速入門”

五個步驟，約五分鐘：

  1. 註冊：前往 app.engram.page 註冊，並完成 新手引導精靈（接受條款、選擇方案）。
  2. 安裝 Engram Vault Sync 外掛：在 Obsidian 中開啟 Settings → Community plugins → Browse，搜尋 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 “接下來”