CouchDB for Obsidian LiveSync — Cloudron community package

A Cloudron community package that runs Apache CouchDB 3.5.2, preconfigured out-of-the-box as the sync backend for the Obsidian Self-hosted LiveSync plugin.

Unlike a bare CouchDB, after install you do not run single-node setup, create an admin, fix CORS, or tweak config. The container comes up already valid for LiveSync. You just read the generated credentials and paste them into the plugin on each device.

What it configures for you

• Single-node setup completed ([couchdb] single_node = true) → system DBs created on boot.
• Strong admin password generated on first run (never hardcoded).
• require_valid_user = true, with require_valid_user_except_for_up = true so the /_up health check stays reachable.
• CORS for Obsidian desktop and mobile: app://obsidian.md, capacitor://localhost, http://localhost.
• max_http_request_size / max_document_size tuned for notes + attachments.
• Default obsidian database auto-created.
• Data + mutable config under /app/data (Cloudron-backed up).

Single-user by design: secured by the CouchDB admin password, not Cloudron SSO — LiveSync is personal single-user sync, not multi-user collaboration.

Install

Cloudron dashboard → App Store → Add custom app → Community app, then paste the raw URL:

https://raw.githubusercontent.com/fengchang/couchdb-cloudron/main/CloudronVersions.json

Only this file needs to be public to install the app.

After install: connect Obsidian LiveSync

1. Get your credentials. They're generated on first run and written to /app/data/credentials.txt (and printed once to the app log). Retrieve via the app's Terminal (cat /app/data/credentials.txt), the File Manager, or the log view. The file contains the full HTTPS endpoint URL, username (admin), password, and the obsidian database name.
2. Enter them in the plugin under Self-hosted LiveSync → Remote Database configuration, then run Check database configuration.

POSTINSTALL.md has the full step-by-step, including the two mobile gotchas (CORS and "On events" sync mode) and the back-up-first warning. It's also shown to you automatically right after install.

Security note

The endpoint is internet-reachable and require_valid_user is on — keep the admin password safe. Anyone with it can read/write your synced vaults.

License

This packaging (Dockerfile, scripts, config, docs) is licensed under the MIT License. It installs and redistributes Apache CouchDB, which is licensed separately under Apache-2.0. The CouchDB name and logo are trademarks of the Apache Software Foundation.

Packaging internals, the build/test loop, and how to publish this package are in DEVELOPER.md.