Guides

Set up Relay

• Install Relay for Obsidian Install and enable the stable Relay plugin in Obsidian, then sign in to join a shared space or start your own.
• Open Relay settings Open Relay settings in Obsidian on desktop or mobile with the command palette, the Relay ribbon icon, or Obsidian Settings.
• Choose how to host Relay Choose between self-hosting a Relay Server and using Relay cloud hosting, including storage and privacy considerations.
• Create a Relay Server Use the Relay Server created for your account, or create and name another in Obsidian.
• Share a folder Share a local Obsidian folder on a Relay Server and make it available to collaborators.
• Invite someone to collaborate How to invite a collaborator to your Relay Server, share a folder with them, and start working together in real time.

Collaborate

• Collaborate on an Obsidian Canvas Share an Obsidian Canvas with your team and edit cards and connections together through Relay.
• Collaborate with Obsidian Bases Share a Base and its notes so your team can work with the same information.
• Sync non-Markdown files Which file types Relay syncs in a Shared Folder, which need storage, and how to turn on Other files to sync HTML, CSV, JSON, text, and Office files.
• Save attachments next to your notes Change Obsidian's default attachment location so pasted images and other attachments are saved inside your Shared Folder, next to the notes that use them.
• Let your agent edit shared notes Your agent edits the files on your disk, and Relay carries those edits to your team.

Manage access

• Create a Shared Folder with private access How to share a Relay Shared Folder with only selected users.
• Remove a user from a Relay Server Remove a collaborator in Relay Server settings, replace the share key, and understand what happens to their local files.
• Rotate a share key Replace a Relay Server share key, share the replacement, and manage who can join.

Maintain your setup

• Backing up your Obsidian vault How to set up backups for an Obsidian vault that uses Relay, and what recovery options are available.
• Using Relay with other sync services How to safely use Relay alongside other sync services like Obsidian Sync, iCloud, and Dropbox.
• Update Relay How to check your current Relay version and update to the latest release.
• Install the latest Relay beta How to install the latest Relay beta with BRAT or a local coding agent.
• Delete Shared Folders, notes, or subfolders Remove a device’s copy, end collaboration on a Shared Folder, or delete shared notes and subfolders.

More

• Upgrade to a paid plan How to upgrade your Relay Server to a paid subscription.