Edit remote Obsidian vaults over SSH/SFTP — like VS Code Remote-SSH, but for Obsidian.
Open a vault that lives on a Raspberry Pi, home NAS, VPS, or any SSH-reachable Linux/macOS host directly in Obsidian. Files are kept in sync via a tiny signed daemon on the server side; your data never touches a third-party cloud.
Start here
| If you want to… | Read |
|---|---|
| Try it in 5 minutes | Quickstart |
| Walk through the whole setup once, with verification | Tutorial — zero to a working vault |
| Understand what gets installed where | Install → First connect |
| Cookbook: do task X | Cookbook (RPi vault, SSH key, Tailscale, systemd) |
| Look up a specific setting | Configuration reference |
| Run your own server | deploy guide |
| Run the daemon by hand (systemd, containers, debugging) | Daemon CLI reference |
Hand-edit data.json or build it from a script | data.json schema reference |
| Speed it up — “things feel slow” | Performance tuning |
| Decide if this plugin is the right tool vs Sync / Syncthing / Git | Comparison vs other Obsidian sync tools |
| Verify the daemon binary you downloaded | Cosign verification |
| Build something against the protocol | API & protocol reference (and copy-pasteable JSON-RPC examples) |
| Look up a term | Glossary |
| What’s coming next | Roadmap |
Sections
- Getting started — install, first connect, what to expect
- Tutorial — long-form walkthrough from zero to verified setup
- Cookbook — task-oriented how-tos (RPi vault, SSH keygen, Tailscale, systemd)
- User guide — SSH config import, jump hosts, host keys, conflict handling, terminal pane, plugin compatibility
- Configuration reference — every plugin setting documented
- deploy — Docker, systemd, Raspberry Pi, auto-deploy
- API & protocol — RPC methods, error codes, payload shapes, copy-pasteable examples
- Security — threat model, signing, token handling, host-key trust
- Operations — logs, daemon panel, reconnect, upgrading, uninstalling, common failures
- Reference — daemon CLI flags,
data.jsonschema - Architecture — shadow vault design, sync internals, performance
- Contributing — dev setup, testing, release flow, docs guide
- Glossary — terms used across the docs, defined once
- Roadmap — what’s left before v1.0 + v2 mobile plan
- Changelog & releases — major-milestone overview + how to find per-release notes
- Privacy & data handling — what data this plugin handles, where it lives, what does (or does not) leave your machines
- Migration — switchover guides (currently from Obsidian Sync; more planned)
- Comparison — full breakdown vs Obsidian Sync, Syncthing, Dropbox/iCloud, Git-based, Nextcloud, and the Remotely Save plugin
- FAQ — quick answers to recurring questions
Release channels
| Channel | Manifest source | Install via | Cadence |
|---|---|---|---|
| Stable | manifest.json (root) | Obsidian Community Plugins | When next is promoted to main (manual) |
| Beta | manifest-beta.json (root) | BRAT (obsidian42-brat, slug sotashimozono/obsidian-remote-ssh, —beta) | Every merge to next (continuous) |
The version shape is the truth: 1.0.43 is stable, 1.0.44-beta.N is a prerelease. See CONTRIBUTING.md → Branching model for how that’s enforced.
Project status
1.0 released. The shadow-vault architecture is operational; BRAT users are running it daily. Community-store listing is pending Obsidian-team review (obsidianmd/obsidian-releases#12390). Mobile support (iOS/Android) is parked as a v2.0 milestone (#151). See the GitHub issues for the live roadmap.
License
MIT.