Self-host CouchDB on a VPS

A document database with an HTTP API, built-in replication and the Fauxton admin console.

levelrail-cli templates install couchdb --name my-couchdb

Specification

Status
Verified on arm64 with image tag 3.4
Category
Database Tools
Services
couchdb
Ports
5984
Volumes
1
Memory
about 512 MiB
arm64
tested
amd64
image published
Settings to fill in
none
License
not yet recorded

About CouchDB

A document database with an HTTP API, built-in replication and the Fauxton admin console.

What it deploys

CouchDB runs as one service in a single Compose app, listening on port 5984, with 1 named volume mount.

ServiceImageTagPortsVolumes
couchdb couchdb 3.4 5984 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.
  • Verified. Verified on arm64 with image tag 3.4. Verified means our CI ran this exact image version and it answered on its health path. Evidence

Settings and environment

You do not have to fill in anything. 1 secret is generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
couchdbCOUCHDB_PASSWORDGenerated at deploy
couchdbCOUCHDB_USERPreset by the template

Install CouchDB on a VPS

  1. 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
  2. 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 | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get couchdb
  4. Install it

    This template has an install form, so the CLI fills each setting from --env, a generated secret or its default.

    levelrail-cli templates install couchdb --name my-couchdb

    To put a service behind a domain at install, add --domain SERVICE=HOST:

    levelrail-cli templates install couchdb --name my-couchdb --domain couchdb=couchdb.example.com

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then CouchDB.

More in Database Tools

All Database Tools templates