# VaultLink: Your notes, beside the web.

> VaultLink opens an Obsidian vault in a browser or Chrome side panel, reached from your other devices over private Tailscale and protected by a pairing token.

By Donovan Baney (@baney75). Page: https://dbaney.com/projects/vaultlink/

- **Price:** Free
- **Status:** Version 0.1.0
- **Runs on:** macOS or Linux companion; any modern browser to connect
- **Built with:** TypeScript, Node.js, Chromium side panel, Tailscale
- **License:** MIT
- **Source:** https://github.com/baney75/vaultlink
- **Documentation:** https://dbaney.com/projects/vaultlink/docs/ (Markdown: https://dbaney.com/projects/vaultlink/docs.md)

## Why I built it

My notes live on one computer, but questions come up everywhere. VaultLink opens an Obsidian vault in a browser or Chrome side panel, reached from my other devices over private Tailscale and protected by a pairing token.

## Two ways in

The VaultLink workspace is a focused browser editor for notes, search, Markdown preview, PDF markup and image copies. When I need my Obsidian themes and plugins, the native option streams the real Linux Obsidian app into the browser instead. They are separate sessions on separate addresses.

## Careful with the files

Existing note bytes are backed up outside the vault before they are replaced. Hidden folders, including `.obsidian`, are never served by the workspace. The companion listens only on this computer, and the pairing token works like a password.

## Your notes on every device you trust

- Edit, search and preview the vault's ordinary Markdown files, with wiki links and an outline.
- Mark up PDFs and keep edited image copies; originals are preserved.
- Notice changes saved elsewhere and offer conflict recovery.
- Reach the vault from another device over private Tailscale Serve, never the public internet.
- Optionally stream the real Obsidian desktop for themes and plugins.

## Limits

The workspace has its own editor and does not run Obsidian themes or plugins. Windows companion setup has not been verified.

## Install

```
node setup.mjs
```

## Questions and answers

### What is VaultLink?

VaultLink opens an Obsidian vault in a browser or Chrome side panel, reached from your other devices over private Tailscale and protected by a pairing token.

### Is VaultLink free?

Yes. VaultLink costs nothing, and its source code is on GitHub under the MIT license.

### How do I set up VaultLink?

On the computer that holds your vault, download the companion ZIP from the latest release, extract it and run `node setup.mjs` with Node.js 22.12 or newer. The Chromium side panel is a separate ZIP you load as an unpacked extension.

### What does VaultLink run on?

The companion runs on macOS or Linux. You connect from any modern browser, or from the side panel in Chromium 116 or newer. Windows companion setup has not been verified.

### Is my vault exposed to the internet?

No. The companion listens only on its own computer, and every request needs the pairing token. Other devices reach it over Tailscale Serve on your private network, not the public internet.

### Does VaultLink have limits?

The workspace has its own editor and does not run Obsidian themes or plugins. Windows companion setup has not been verified.

## Related projects

- [Waypost](https://dbaney.com/projects/waypost/): Waypost connects AI agents to Proton Mail, Drive and Calendar through a local CLI and MCP server. Reading is the default; sending and uploading stay off until you allow them, and every write needs confirmation.
- [Stillport](https://dbaney.com/projects/stillport/): Stillport gives AI agents a CLI and an MCP server for Apple Photos, Google Photos Picker and local Google Takeout archives. Search natively, inspect metadata, and export only what the agent needs to see.
- [BaneySpaces](https://dbaney.com/projects/baneyspaces/): A free Mac workspace manager. Press ⌘1–⌘9 to switch spaces instantly, add Shift to move a window, and open a Deck of terminals and coding agents. Agents get a workspace of their own so automation stays out of your way.
