# Self-host Obsidian LiveSync (CouchDB)

> A self-hosted CouchDB backend for the Obsidian LiveSync plugin, syncing your notes across devices.

- Page: https://levelrail.com/templates/obsidian-livesync/
- JSON: https://levelrail.com/templates/obsidian-livesync.json
- Category: Productivity
- Licence: MIT (Permissive license)
- Source: https://github.com/vrtmrz/obsidian-livesync
- Upstream docs: https://github.com/vrtmrz/obsidian-livesync/blob/main/docs/setup_own_server.md

## Requirements
- Memory: about 256 MiB
- amd64: published, arm64: published
- Needs configuration before start: no
- Pinned image tag: 3.5.2

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| couchdb | couchdb | 3.5.2 | 5984 | couchdb_data -> /opt/couchdb/data |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| couchdb | COUCHDB_PASSWORD | generated |
| couchdb | COUCHDB_USER | generated |

## Deploy

### CLI

```bash
levelrail-cli templates deploy obsidian-livesync --name my-obsidian-livesync
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/obsidian-livesync/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## Questions

### 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.

Self-host Obsidian LiveSync (CouchDB), Obsidian LiveSync (CouchDB) docker compose file, deploy Obsidian LiveSync (CouchDB) on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
