I grew to become my Obsidian vault right into a shared workspace—without spending a dime

Obsidian may let you construct a 2nd mind, however it received’t let you collaborate with a 2nd individual. It’s famously a local-only software. If you wish to proportion your notes with somebody else, it’s a must to zip up your vault and e mail it over—which is a clunky answer. However, you’ll be able to add your vault to a cloud carrier like Google Pressure—however then your native notes are uncovered to a third-party server.

This has all the time been a troubling limitation for me, till now. I discovered this app that allows Google Medical doctors-style collaboration on my Obsidian vault. The most efficient section is that it’s utterly unfastened and infrequently takes 5 mins to arrange.

It is all conceivable because of this one GitHub repo

Say hi to CollabMD

I used to be in a position to develop into my Obsidian vault right into a collaborative workspace because of CollabMD—a Node.js server that you simply run in the community to your system. You get started the server by means of pointing it to a folder to your pc—on this case, your Obsidian vault—and it spins up a browser-based editor that anybody can get admission to.

It’ll generate a URL, and any person with the URL can now get admission to your Obsidian vault thru their browsers. They may be able to make edits on your Obsidian notes from the browser, and the adjustments will likely be mirrored to your precise vault. It offers you real-time edit syncing powered by means of Yjs—a CRDT (Battle-free Replicated Knowledge Sort) library.

What this implies is that more than one other folks can kind in the similar report on the similar time—and all their adjustments get merged with out one individual’s edits overwriting every other’s. It’s necessarily the similar collaborative enjoy you notice in gear like Perception and Google Medical doctors.

How the Obsidian notes are shared over the web

For sharing over the web, CollabMD makes use of Cloudflare Fast Tunnels. All it’s a must to do is set up cloudflared—a unfastened CLI software from Cloudflare. As soon as CollabMD begins, it routinely creates a tunnel and prints a public URL you’ll be able to proportion. You don’t have to fret about making a Cloudflare account or subscribing to a paid plan. The URL will glance one thing like this: https://locking-effect-grove-learning.trycloudflare.com—it’s randomly generated and will likely be other for each and every consultation.

Coming on your Obsidian vault, CollabMD doesn’t transfer it to a cloud server—the whole lot remains to be native. The MD information sit down to your disk the entire time. Bring to mind it like your device itself changing into the server, together with your Obsidian vault because the database being served over the web.

How does CollabMD paintings

A snappy evaluation of the options and interface

Whenever you open the URL in a browser, the very first thing it asks you for is a username. That is how other folks within the consultation will see you. There is a coloured avatar indicator within the best proper appearing who is these days on-line. Your identify may also seem at the record in keeping with the placement of your cursor—very similar to the way it appears to be like in Google Medical doctors.

The interface itself is lovely minimum. You get a three-column structure by means of default. There’s a report and folder sidebar at the left, a Markdown editor within the middle, and a rendered preview at the proper. After all, you’ll be able to flip it right into a two-panel structure by means of collapsing both the markdown editor or the rendered preview.

There is a formatting ribbon on the best of the editor with the fundamentals—daring, italic, code, hyperlinks, tables. That is in fact extra helpful than it sounds, particularly when you are sharing your vault with somebody who does not write in Markdown. That ribbon guarantees they are able to nonetheless make edits with out realizing any syntax.

At the matter of enhancing, the essential factor to grasp is that anything else you convert within the browser will get written again to the real report to your vault. Those are genuine edits to genuine information—there is not any sandbox, no staging house, no “suggest adjustments” mode. In case your collaborator deletes a paragraph, it is long gone from the report.

That’s why, as an alternative of without delay enhancing the report, I for my part counsel the usage of the remark characteristic. It shall we other folks spotlight any line or piece of textual content and go away a word. The remark presentations up as a small inline marker within the editor and a bubble within the preview. You’ll have complete threaded conversations on explicit strains with none of it wearing over into the supply Markdown. The feedback are unique to the CollabMD browser enjoy.

There may be additionally a staff chat panel you’ll be able to open from the highest proper. It is only a fundamental chat characteristic that lets you see who’s on-line and ship messages to everybody on-line. It’s in particular helpful for fast back-and-forth when you do not need to mess the record with feedback.

OS

Home windows, iOS, Android, macOS, Linux

Emblem

Obsidian

Obsidian is a note-taking and database advent app that permits you to retailer notes privately, so others can not see them until you proportion them. It additionally has tough third-party app toughen, so you’ll be able to customise the whole lot simply the way in which you need it.

How you can arrange CollabMD and switch your Obsidian vault right into a shared workspace

It’ll slightly take 5 mins

CollabMD natively works on Linux and macOS. In the event you’re on Home windows, you’ll want to undergo WSL 2 (Home windows Subsystem for Linux). Right here’s an in depth information on methods to set up and arrange WSL 2. For the most productive enjoy, I’d counsel that you simply set up Ubuntu the usage of WSL.

After you have that during position, you’ll want Node.js edition 24 and cloudflared to run CollabMD. For the needs of this demo, I’m going to suppose you don’t have both of them put in.

To put in Node.js, input the next instructions into the terminal:

curl -fsSL  | sudo -E bash -

sudo apt set up -y nodejs #if you are the usage of Ubuntu

Then examine it labored:

node --version

You will have to see v24.x.x.

Subsequent, to put in cloudflared, input this command:

curl -L  -o cloudflared && chmod +x cloudflared && sudo mv cloudflared /usr/native/bin/

To ensure that it’s put in, input:

cloudflared --version

After all, it’s time to run CollabMD. Simply input the next command:

npx collabmd@newest "[path_to_obsidian_vault]"

Exchange “[path_to_obsidian_vault]” with the real report trail.

The primary time you run this, it will obtain CollabMD after which get started the server. Watch the output for a line that appears like this: “https://some-random-words.trycloudflare.com”—that’s the shareable URL. Ship it to whoever you need to collaborate with. They open it of their browser, select a username, and they are in—no set up required on their finish.

If you wish to password-protect your vault prior to sharing, use this command:

npx collabmd@newest "/mnt/c/Customers/YourName/Paperwork/my-vault" --auth password

It’s now not a really perfect device

There are nonetheless some barriers you want to concentrate on

Credit score: 

Lucas Gouveia/How-To Geek

Whilst it’s superb that I will be able to in the end proportion my Obsidian vault with my family and friends and collaborate on it—the enjoy is a ways from best. The largest limitation is that there is not any permission device. There is no view-only mode, no comment-only mode, no technique to prohibit what a collaborator can contact.

As such, in the event you’re apprehensive about somebody wreaking mayhem throughout your Obsidian vault, the cleanest workaround is to replicate the vault after which proportion the replica. This fashion, your primary vault remains untouched and also you don’t want to concern about somebody making any damaging adjustments on your notes. And in the event you accept as true with the adjustments they made, you’ll be able to simply replica the ones adjustments over on your primary vault.

Additionally, each and every collaboration consultation solely lives so long as your terminal is open. Take into account, CollabMD is principally turning your pc right into a server. So in the event you shut CollabMD, shut the terminal, or energy off the pc, your Obsidian vault is now not on-line.

As opposed to this, there’s additionally the truth that the URL adjustments each and every unmarried time you restart CollabMD. Cloudflare Fast Tunnels are intended for transient periods, now not everlasting shared workspaces. As such, you’ll be able to’t simply proportion a URL on your collaborator to get admission to a month later.

It’s just right sufficient for many Obsidian customers

CollabMD received’t flip your Obsidian vault right into a Perception database—however it by no means set out to try this within the first position. It’s designed to unravel the ones moments when you need to proportion your vault with buddies or circle of relatives, and in addition collaborate with them in genuine time.