Zima Topic Sync

Zima Topic Sync mirrors an Obsidian vault into the currently selected Zima Topic so the notes and attachments can be used from Zima.

The sync is one-way: Obsidian → Zima. Pairing links are single-use, expire after ten minutes, and bind one Obsidian vault to one Zima account and Topic.

What gets synced

When creating a connection link in Zima, choose Keep syncing or Sync once. Both modes pair the active vault and upload all files except hidden paths and the .obsidian, .trash, .git, and node_modules folders. Keep syncing continues to mirror creates, edits, renames, and deletions. Sync once stops after the initial complete snapshot. You can still paste the connection link manually from the plugin settings when protocol links are not available.

The plugin sends vault file contents, relative file paths, file size and modification time, vault name, device name, plugin version, and a randomly generated vault identifier to the Zima server selected by the pairing link. It stores the Zima server address and a device credential in the plugin's local Obsidian settings. It does not include analytics or third-party telemetry.

Use HTTPS for remote Zima servers. Plain HTTP is accepted only for a Zima server running on the same device through localhost, 127.0.0.1, or ::1.

Install

1. Open Settings → Community plugins → Browse in Obsidian.
2. Search for Zima Topic Sync.
3. Select Install, then Enable.
4. From the Obsidian connector page in Zima, create a connection link and select Open Obsidian and connect. The plugin receives the one-time link and connects the active vault automatically.

Disconnect and revoke access

Selecting Forget this connection removes the locally stored device credential. To invalidate the credential server-side, revoke the Obsidian device from Zima as well. Disconnecting does not delete files that have already been mirrored to Zima.

Development

Install dependencies and verify the plugin:

pnpm install
pnpm check

pnpm build regenerates main.js from main.ts.

License

Apache-2.0