Install Relay for Obsidian

On this page

Relay adds real-time collaboration to your Obsidian vault. Install the plugin from Obsidian’s community directory, enable it, and sign in to your Relay account.

After signing in, join the server you were invited to or share a folder on your own server.

Before you start

Install Obsidian and open the vault where you want to use Relay.

The community directory provides the stable release. To test a prerelease, follow Install Relay beta instead.

Install the plugin

  1. In Obsidian, open Settings → Community plugins.
  2. If Restricted mode is on, select Turn on community plugins.
  3. Select Browse, then search for Relay.
  4. Select Relay by Relay.md, then select Install.
  5. When installation finishes, select Enable.
  6. In the Settings sidebar, select Relay. For other ways to reach it, see Open Relay settings.
Relay by Relay.md in Obsidian’s community plugin directory.
Choose Relay by Relay.md in the community directory.

For help with Obsidian’s plugin controls, see Community plugins.

Sign in to Relay

  1. In Relay settings, select a sign-in provider.
  2. Follow the provider’s sign-in prompts.
  3. Return to Relay settings in Obsidian and check that your account appears under Account.
Relay sign-in buttons for GitHub, Google, and Microsoft.
Select a sign-in provider in Relay settings.

Continue setup

If you were invited: Have your Share Key ready, then follow Join from an invitation to join the server and add its Shared Folder to your vault.

If you’re starting fresh: Relay creates a Relay Server for you when you sign up. Share a folder on that server.

To host Relay on your own infrastructure, see Choose how to host Relay.