Getting started
The shortest path from “never used this plugin” to “editing a remote vault from Obsidian”. Three pages, in order.
Pages
| # | Page | Time |
|---|---|---|
| 1 | Install | ~2 min |
| 2 | First connect | ~5 min |
| 3 | Quickstart (alternative entry point) | ~5 min total |
Two paths through
If you have an SSH-reachable host already (Pi, NAS, VPS, work box):
- Quickstart — the 5-minute version, skips the deep explanations.
If you want to know what’s happening at each step:
- Install — what you’re installing, how the channels work.
- First connect — what happens behind the scenes when you click Connect for the first time (binary upload, daemon spawn, shadow vault materialisation).
Both paths converge on the same working state. Pick by appetite for explanation.
What if I don’t have a remote yet?
Set one up first, then come back:
- Cookbook: Raspberry Pi vault from scratch — turn-key Pi recipe.
- Cookbook: Share a vault via Tailscale — VPS or home box reachable from anywhere.
Next, after first connect
- User guide — feature walkthroughs you’ll want during normal use.
- Configuration → Profiles — every per-profile setting documented.
- Operations → Troubleshooting — for when something doesn’t work.
See also
- Tutorial — long-form walkthrough from zero to verified setup, more thorough than Quickstart.
- Comparison — if you’re not yet sure this plugin is the right tool.