install guide

From invite to a shared folder

Every step, with the labels exactly as Obsidian and the plugin show them. It takes about five minutes.

1Before you start

  • Obsidian 1.11.4 or newer, on desktop or mobile.
  • An invite link from whoever runs your ArcaSync server. Accounts are invite-only. Invites expire after 7 days by default and usually work once.

2Install the plugin

With BRAT recommended

ArcaSync isn't in the community plugin list. BRAT installs it from GitHub and keeps it updated.

  1. Open Obsidian Settings → Community plugins. If Restricted mode is on, turn it off.
  2. Click Browse, search for “BRAT” (by TfTHacker), then Install and Enable.
  3. Open the command palette and run BRAT: Plugins: Add a beta plugin for testing (with or without version).
  4. Paste the repository and confirm:
    randomdev3/arcasync
  5. Back in Community plugins, enable ArcaSync.
  6. Updates: BRAT checks when Obsidian starts. To check now, run BRAT: Plugins: Check for updates to all beta plugins and UPDATE.

Or install by hand

  1. Download main.js, manifest.json and styles.css from the latest release at github.com/randomdev3/arcasync/releases.
  2. Create the folder <your vault>/.obsidian/plugins/arcasync/ and put the three files in it. .obsidian is hidden: on macOS press Cmd+Shift+. in Finder; on Windows use View → Show → Hidden items.
  3. In Settings → Community plugins, click reload (↻), then enable ArcaSync.

3Point it at the server

Open Settings → ArcaSync → Server URL and paste:

https://arcasync-relay.studentranoa.workers.dev

The default points at localhost, which only works for development. If you open an invite with Open in Obsidian, it fills this in for you after you confirm.

4Sign in

Pick the row that matches you.

I have an invite and no account yet

Any one of these:

  • Open the invite link and click Open in Obsidian. Confirm Join an ArcaSync server, enter your name and join.
  • Or paste the link into Settings → ArcaSync → Join with an invite, fill in Your name and click Join. Set the Server URL first: the link opens this website, not the server.
  • Or create the account in the browser on the invite page, then continue with the next row.

I made my account in the browser

In Settings → ArcaSync, click Sign in with another device. Obsidian shows a code and a link: open the link in the browser where you made your account (or go to the approve page) and approve the code.

I'm signed in on another device that has Obsidian

On the new device, click Sign in with another device. On the old one, run ArcaSync: Approve a device sign-in and enter the code.

An invite works once. If you already used it, don't open it again; use a sign-in code.

5Share a folder

  1. Go to Settings → ArcaSync → Shared folders → Add folder.
  2. Pick or type a folder, choose the workspace, then click Connect.

One folder per workspace, and folders can't be inside each other. Notes already in the folder upload. If a friend has a note at the same path, the texts are merged; when they can't be merged cleanly, your version is kept as a local copy next to it, so nothing is lost. To start fresh, use a new empty folder.

6Working together

  • Coloured carets with names are live, and so are selections.
  • Avatars of who's here appear in the status bar and on the folder.
  • ArcaSync: Jump to user… opens their note at their cursor. ArcaSync: Follow user… keeps following them until you move.
  • Attachments (images, PDFs, anything) sync too, up to 200 MB each.
  • Viewers can read but not edit.

7Troubleshooting

“This link is not a valid ArcaSync invite”

The link was cut off. Copy all of it, including everything after invite=.

The invite page says “already used”

Sign in with a code instead (the second or third row under Sign in).

The code expired

Codes last 10 minutes. Click Sign in with another device again.

“Session expired — connect again to sign in”

Sessions last 90 days. Sign in again.

The connection status shows an error

Check the Server URL: it starts with https:// and has no path after it. Then click Disconnect and Connect.

Nothing syncs

Is the folder mapped under Shared folders, and does the status bar show the workspace connected?

On mobile

Install BRAT the same way, then sign in with a code approved from your desktop.

Updating

BRAT updates on startup. For a manual install, replace the three files.

Leaving

Click Sign out in settings. The files in your folder stay.