Skip to content

Obsidian Sync Component (OB)

1. What this is

MemoFlow Bridge syncs MemoFlow local-library content into Obsidian.
Current implementation is LAN local mode using a local bridge plugin in Obsidian.

Your plugin is not in Obsidian Community Plugins yet, so install manually.
Plugin repo: https://github.com/hzc073/memoflow_obsidian_plugin

2. Entry

Settings -> Components -> MemoFlow Bridge

This page supports:

  • QR pairing
  • mDNS discovery
  • Manual Host / Port / Pair Code pairing
  • Health check
  • Enable / disable bridge

3. Install Obsidian plugin (manual)

  1. Open your Obsidian vault folder.
  2. Create plugin folder: .obsidian/plugins/memoflow-sync-bridge/.
  3. Copy at least these files from memoflow_obsidian_plugin:
    • main.js
    • manifest.json
  4. In Obsidian, go to Settings -> Community plugins and enable it.

Notes:

  • Plugin is desktop-only.
  • Default plugin port is 3000 (configurable in plugin settings).
  1. Show pairing QR in Obsidian plugin.
  2. In MemoFlow Bridge page, tap “Scan to Pair”.
  3. App calls /bridge/v1/pair/confirm and stores returned token.

Option B: mDNS discovery + manual code

  1. Tap “mDNS Discover” and pick discovered service.
  2. Enter pair code from Obsidian plugin.
  3. Tap “Confirm Pair”.

Option C: fully manual

Fill Host, Port, and Pair Code, then confirm pairing.

5. Sync after pairing

You have two common paths:

  1. In Sync Queue, tap “Sync to Obsidian”:
    • Batch pushes current local-library memos (including attachments) to paired Obsidian.
  2. Use normal local sync flow:
    • When bridge is enabled and paired, client also attempts upload to /bridge/v1/memo/upload.

6. Common issues

Service not found / pairing fails

  • Ensure phone and desktop are in same LAN.
  • Ensure firewall is not blocking plugin port (default 3000).
  • Pair code expired (default TTL is 120s), regenerate and retry.

Health check failed

  • Run Health Check after pairing to verify /bridge/v1/health.
  • If failed, verify Host/Port and plugin running status.

QR scan unavailable

  • QR scanning currently supports Android / iOS only.
  • On other platforms, use manual pairing (Host + Port + Pair Code).