Self-host Obsidian LiveSync (CouchDB) with Levelrail
A self-hosted CouchDB backend for the Obsidian LiveSync plugin, syncing your notes across devices.
- Authorvrtmrz
- LicenceMIT
- Memory256 MiB
- Archarm64
- Services1
How to self-host Obsidian LiveSync (CouchDB)
-
Pull the images
One image is pulled on your server.
Show images
couchdb:3.5.2
-
Create the app
One service starts in a single Compose app, with 1 named volume mount for your data, on port 5984.
-
Fill in the secrets
2 secrets are generated and stored encrypted, you do not have to fill in anything.
-
Open it
Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.
Obsidian LiveSync (CouchDB) requirements
- Memory
- About 256 MiB
- Architectures
- amd64 image published, arm64 image published
- Ports
- 5984
- Domain
- Optional, an sslip.io address is used without one
- Settings
- none to fill in
- License
- MIT, permissive license
- Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
- Host ports. It publishes port 5984 on the host, so open them in the VPS firewall only if you want that.
Install Levelrail first
On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Obsidian LiveSync (CouchDB). New to Levelrail? Install it on a fresh VPS first.
docker pull ghcr.io/glincker/levelrail:latest Then levelrail-cli login --device. See Getting started and the Obsidian LiveSync (CouchDB) docs page.
Deploy Obsidian LiveSync (CouchDB) your way
Every format below deploys the same pinned images. Pick the one that fits how you work.
Deploy Obsidian LiveSync (CouchDB) from the CLI
levelrail-cli templates deploy obsidian-livesync --name my-obsidian-livesync Deploy Obsidian LiveSync (CouchDB) with the API
curl -X POST -H "Authorization: Bearer $TOKEN" \
https://levelrail.example.com/api/v1/service-templates/obsidian-livesync/deploy Obsidian LiveSync (CouchDB) configuration
Obsidian LiveSync (CouchDB) services
| Service | Image | Ports | Volumes |
|---|---|---|---|
| couchdb | couchdb:3.5.2 | 5984 | couchdb_data -> /opt/couchdb/data |
Obsidian LiveSync (CouchDB) environment variables
| Variable | Service | Value |
|---|---|---|
| COUCHDB_PASSWORD | couchdb | Generated at deploy |
| COUCHDB_USER | couchdb | Generated at deploy |
Ports and volumes
- Ports
- 5984
- Volumes
- 1 named mount: couchdb_data -> /opt/couchdb/data
Obsidian LiveSync (CouchDB) FAQ
How much memory does Obsidian LiveSync (CouchDB) need?
The catalog lists about 256 MiB of memory for Obsidian LiveSync (CouchDB).
Does Obsidian LiveSync (CouchDB) run on arm64?
For Obsidian LiveSync (CouchDB), an arm64 image is published; amd64 is image published.
What licence is Obsidian LiveSync (CouchDB) under?
Obsidian LiveSync (CouchDB) is licensed under MIT, which is permissive, with few conditions on reuse.
Does Obsidian LiveSync (CouchDB) need configuration before it starts?
No. The template fills in its own defaults and generates secrets at deploy time.
Which ports does Obsidian LiveSync (CouchDB) use?
Obsidian LiveSync (CouchDB) listens on port 5984 inside the stack.
Where does Obsidian LiveSync (CouchDB) keep its data?
In a named volume: couchdb_data mounted at /opt/couchdb/data.
Can I deploy Obsidian LiveSync (CouchDB) on Dokploy or Dokku?
The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id obsidian-livesync for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image couchdb:3.5.2 is what you deploy there.