Self-host Obsidian LiveSync (CouchDB) on a VPS
A self-hosted CouchDB backend for the Obsidian LiveSync plugin, syncing your notes across devices.
levelrail-cli templates deploy obsidian-livesync --name my-obsidian-livesyncSpecification
- Status
- Listed
- Category
- Productivity
- Services
- couchdb
- Ports
- 5984
- Volumes
- 1
- Memory
- about 256 MiB
- arm64
- image published
- amd64
- image published
- Settings to fill in
- none
- License
- Permissive license, MIT
About Obsidian LiveSync (CouchDB)
A self-hosted CouchDB backend for the Obsidian LiveSync plugin, syncing your notes across devices. Runs as a single container from the couchdb image, listening on port 5984; data is kept in named volumes.
What it deploys
Obsidian LiveSync (CouchDB) runs as one service in a single Compose app, listening on port 5984, with 1 named volume mount.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| couchdb | couchdb | 3.5.2 | 5984 | couchdb_data -> /opt/couchdb/data |
Before you install
- CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
- Listed. It is in the catalog. Back up the data volume before changing an image tag.
- Host ports. It publishes port 5984 directly on the host, so open them in the VPS firewall only if you want that.
Settings and environment
You do not have to fill in anything. 2 secrets are generated at deploy and stored encrypted. Values are never shown here.
| Service | Variable | Value |
|---|---|---|
| couchdb | COUCHDB_PASSWORD | Generated at deploy |
| couchdb | COUCHDB_USER | Generated at deploy |
Install Obsidian LiveSync (CouchDB) on a VPS
-
Install Levelrail on a fresh VPS
Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.
curl -fsSL https://levelrail.com/install.sh | sudo sh -
Sign in
Open the setup link, choose a password, then log the CLI in. The CLI install command is
curl -fsSL https://levelrail.com/install-cli.sh | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get obsidian-livesync -
Deploy it
This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.
levelrail-cli templates deploy obsidian-livesync --name my-obsidian-livesync
Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Obsidian LiveSync (CouchDB).
Docs and upstream
More in Productivity
- osTicketA widely used open-source support ticket system for teams handling customer requests.
- OutlineA fast, structured team wiki and knowledge base with real-time collaborative editing.
- PairDropAn AirDrop-style app for sending files and messages between devices on the same network, from any browser.
- Paperless-ngxScan, index, and archive your paper documents into a searchable digital library.
- MonicaA personal CRM that remembers the people in your life, with notes, reminders, activities and relationships.
- PenpotAn open-source design and prototyping platform, a self-hosted alternative to Figma.