Getting Started with the Peerdraft Obsidian Plugin

The Peerdraft Obsidian plugin enables you to collaborate on documents and folders in real-time while using your preferred note-taking environment.

When to Use This

The Obsidian plugin is ideal when you:

  • Prefer your local workflow: Use Obsidian with all your favorite plugins and collaborate with others using either the web app or Obsidian
  • Need bidirectional sync: Keep notes and folders in your local vault synchronized with a shared Space automatically
  • Collaborate in real-time: Edit markdown documents simultaneously with others
  • Bridge local and cloud: Access your documents via the Peerdraft API or connect AI agents through the MCP endpoint. See changes reflected in your vault instantly
  • Work offline-first: Make changes locally while offline and sync when you’re back online

Installation

Install the Plugin

  1. Open Obsidian
  2. Go to Settings → Community Plugins
  3. Turn on “Community plugins” if not already enabled
  4. Click “Browse”
  5. Search for “Peerdraft”
  6. Click “Install” and then “Enable”

Configuration

Set Your Display Name

  1. Open Obsidian Settings
  2. Go to Peerdraft plugin settings
  3. Enter your display name (shown to collaborators)

Set Root Folder for Imports (Optional)

When you join a share from someone else, the plugin creates the file or folder in your vault. You can configure where:

  1. In Peerdraft settings, find “Root Folder”
  2. Enter a folder path or use the search button to select one
  3. Imported shares will be created inside this folder

Log In to Your Account

To create new shares, you need a Peerdraft account. To join shares from others, no account is needed.

  1. In Peerdraft settings, click “Log in or create account”
  2. Complete the authentication flow
  3. Your plan type and active share count will appear in settings

Using the Plugin

Share a File

To start collaborating on a markdown or canvas file:

  1. Right-click the file in the file explorer
  2. Select Peerdraft > Share File
  3. Choose session type:
    • Fleeting: End-to-end encrypted, ends when you close the file
    • Persistent: Supports offline and async editing, stored at rest and in transit
  4. Copy the URL and share it with collaborators

Alternatively, use the command palette: Peerdraft: Start working together on this document

Share a Folder

To keep an entire folder in sync:

  1. Right-click the folder in the file explorer
  2. Select Peerdraft > Share Folder
  3. Copy the URL and share it with collaborators
  4. New files created by anyone in the folder sync automatically

Join a Share

To join a file or folder shared by someone else:

  1. Get the share URL from your collaborator
  2. Use command palette: Peerdraft: Join session and add document from someone else
  3. Paste the URL
  4. The file or folder appears in your vault (in your root folder if configured)

Real-Time Collaboration

When working on a shared document:

  • Changes sync automatically in real-time
  • See collaborators’ cursor positions and selections
  • Multiple people can edit simultaneously
  • Notifications alert you when someone joins

Manage Your Shares

Click the Peerdraft icon in the left ribbon to view all your active persistent shares.

For individual files or folders, right-click and use the Peerdraft menu to:

  • Copy URL: Get the share link
  • Stop syncing with this vault: Remove from your vault only
  • Stop syncing for everyone: End syncing for all collaborators

Troubleshooting

Connection Issues

If you cannot join a share:

  • Verify the share URL is correct and complete
  • Check your internet connection
  • Ensure the share creator hasn’t ended the session (for fleeting sessions)
  • Try restarting Obsidian

Files Not Syncing

If changes aren’t appearing:

  • Check that you’re online (persistent shares work offline, but sync when reconnected)
  • Verify the file is inside a shared folder (for folder shares)
  • For fleeting sessions, ensure the creator is still online

Security

  • Fleeting sessions: End-to-end encrypted, no content passes through Peerdraft servers
  • Persistent shares: Encrypted in transit and at rest, stored on Peerdraft servers
  • Authentication: Your credentials are stored locally in Obsidian (if you select “keep me logged in”)
  • Access control: Only people with the share URL can access your documents

Tips

  • Use fleeting sessions for quick, private collaboration that leaves no trace on servers
  • Use persistent shares for long-term projects, async work, or when collaborators work offline
  • Set a root folder to keep all imported shares organized in one place
  • Share entire folders to keep team knowledge bases or project documentation in sync
Peerdraft Docs