Get started

This guide walks through installing DraftMesh, creating an account, connecting a vault, and checking sync progress.

Requirements

• Obsidian installed on your device
• An existing Obsidian vault, or a new vault you want to sync
• Access to an DraftMesh sync server URL
• The BRAT community plugin for installing beta Obsidian plugins

1. Install DraftMesh with BRAT

DraftMesh is distributed as an Obsidian plugin. During beta testing, install it with BRAT.

1. Open Obsidian.
2. Go to Settings -> Community plugins.
3. Turn off Restricted mode if needed.
4. Browse community plugins and install BRAT.
5. Open Settings -> BRAT.
6. Choose Add Beta plugin.
7. Paste the DraftMesh plugin repository URL.
8. Install and enable the plugin.

After installation, open Settings -> Community plugins and make sure DraftMesh is enabled.

2. Configure the sync server

1. Open Settings -> DraftMesh.
2. In Connection Settings, set Sync server to the DraftMesh server URL.
3. Use the full URL, including the protocol, for example https://sync.example.com.

If the server URL is wrong or unavailable, login, registration, and sync will fail.

3. Register an account

1. In Settings -> DraftMesh, find Account.
2. Select Sign up.
3. Enter your email address and password.
4. Select Continue.
5. Check your email for the 6-digit verification code.
6. Enter the code and select Create account.

After the account is created, sign in from the same settings panel if you are not already logged in.

4. Create a sync vault

1. In Settings -> DraftMesh, select the vault button next to your account.
2. The Vaults window opens.
3. Select Create vault.
4. Enter a Vault name.
5. Enter a Vault password.
6. Select Create.

The vault password is used when connecting devices to this sync vault. Keep it somewhere safe. If you add DraftMesh to another device, you will need the same account and vault password.

5. Connect the local vault

1. In the Vaults window, find the vault you created.
2. Select Connect.
3. Enter the vault password.
4. Wait for the confirmation notice.

Your local Obsidian vault is now linked to the remote DraftMesh vault. Local notes are not deleted when you connect, disconnect, or switch DraftMesh vaults.

6. Start sync

1. Return to Settings -> DraftMesh.
2. Find Sync status.
3. Turn the sync toggle on.

DraftMesh will begin reconciling local and remote state. The first sync can take longer if the vault has many files.

7. Check sync progress

DraftMesh adds a status bar indicator while sync is active, complete, or interrupted.

• Select the DraftMesh status bar indicator to open Sync progress.
• Enable Reconcile progress in settings if you want more detailed reconcile stages and file transfer details.
• If the indicator reports an error, open it to see the interruption message.
• Use Sync logs -> View in settings when you need more diagnostic detail.

Add another device

Repeat the installation steps on the new device, then:

1. Set the same Sync server.
2. Log in with the same account.
3. Open Vaults.
4. Select Connect on the existing vault.
5. Enter the vault password.
6. Turn sync on.

Wait for Sync progress to settle before making large edits on multiple devices.

Deploy to Cloudflare Pages

The documentation site is built with VitePress.

From the website/docs directory:

npm install
npm run build

Use these Cloudflare Pages settings for the documentation site.

Setting	Value
Framework preset	VitePress
Build command	npm run build
Build output directory	.vitepress/dist
Root directory	website/docs

For local preview:

npm run dev