Self-host CouchDB with Levelrail
VerifiedA document database with an HTTP API, built-in replication and the Fauxton admin console.
- Memory512 MiB
- Archarm64
- Services1
How to self-host CouchDB
-
Pull the images
One image is pulled on your server.
Show images
couchdb:3.4
-
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
1 secret is generated and stored encrypted, 1 setting is preset, 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.
CouchDB requirements
- Memory
- About 512 MiB
- Architectures
- amd64 image published, arm64 tested
- Ports
- 5984
- Domain
- Optional, an sslip.io address is used without one
- Settings
- none to fill in
- License
- not yet recorded
- Verified. Verified on arm64 with image tag 3.4. Our CI ran this exact image version and it answered on its health path. Evidence
Install Levelrail first
On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then 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 CouchDB docs page.
Deploy CouchDB your way
Every format below deploys the same pinned images. Pick the one that fits how you work.
Deploy CouchDB from the CLI
levelrail-cli templates install couchdb --name my-couchdb Deploy CouchDB with the API
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
https://levelrail.example.com/api/v1/service-templates/couchdb/install \
-d '{
"name": "my-couchdb"
}' CouchDB configuration
CouchDB services
| Service | Image | Ports | Volumes |
|---|---|---|---|
| couchdb | couchdb:3.4 | 5984 | data -> /opt/couchdb/data |
CouchDB environment variables
| Variable | Service | Value |
|---|---|---|
| COUCHDB_PASSWORD | couchdb | Generated at deploy |
| COUCHDB_USER | couchdb | Preset by the template |
Ports and volumes
- Ports
- 5984
- Volumes
- 1 named mount: data -> /opt/couchdb/data
CouchDB FAQ
How much memory does CouchDB need?
The catalog lists about 512 MiB of memory for CouchDB.
Does CouchDB run on arm64?
For CouchDB, arm64 is tested; amd64 is image published.
Does CouchDB need configuration before it starts?
No. The template fills in its own defaults and generates secrets at deploy time.
Which ports does CouchDB use?
CouchDB listens on port 5984 inside the stack.
Where does CouchDB keep its data?
In a named volume: data mounted at /opt/couchdb/data.
Can I deploy 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 couchdb for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image couchdb:3.4 is what you deploy there.