Skip to content
daemonlessPublic

Repository files navigation

CouchDB

Build Status Last Commit OCI Pulls

Seamless multi-primary syncing JSON document database with an HTTP API, MapReduce views, and Couch Replication Protocol support.

Port 5984
Registry ghcr.io/daemonless/couchdb
Source https://github.com/apache/couchdb
Website https://couchdb.apache.org/

Version Tags

Tag Description Best For
latest / pkg FreeBSD Quarterly. Uses stable, tested packages. Most users — recommended.
pkg-latest FreeBSD Latest. Rolling package updates. Staying current.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  couchdb:
    image: "ghcr.io/daemonless/couchdb:latest"
    container_name: couchdb
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - COUCHDB_USER=admin  # Administrator username created on first start
      - COUCHDB_PASSWORD=changeme  # Password for COUCHDB_USER (hashed into /config/etc/local.ini on first start; if unset, a random password is saved to /config/admin_password)
      - COUCHDB_SINGLE_NODE=true  # Automatically create _users and _replicator system databases on startup (set false for multi-node cluster setup)
      # - COUCHDB_SECRET=  # Cookie authentication signing secret (generated and persisted in /config/etc/local.d/10-secret.ini if unset)
      # - NODENAME=  # Erlang node host or IP for multi-node clustering (-name couchdb@NODENAME)
      # - COUCHDB_ERLANG_COOKIE=  # Shared Erlang distribution cookie written to /config/.erlang.cookie for clustering
    volumes:
      - "/containers/couchdb:/config"
    ports:
      - "5984:5984"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=couchdb
PUID=1000
PGID=1000
TZ=UTC
COUCHDB_USER=admin
COUCHDB_PASSWORD=changeme
COUCHDB_SINGLE_NODE=true

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  couchdb:
    name: couchdb
    options:
      - container: 'args:--pull'
      - expose: '5984:5984 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - COUCHDB_USER: !ENV '${COUCHDB_USER}'
        - COUCHDB_PASSWORD: !ENV '${COUCHDB_PASSWORD}'
        - COUCHDB_SINGLE_NODE: !ENV '${COUCHDB_SINGLE_NODE}'
    volumes:
      - couchdb: /config
volumes:
  couchdb:
    device: '/containers/couchdb'

Makejail:

# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/couchdb:${tag}

Save the files above, then run appjail-director up.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  couchdb:
    name: couchdb
    image: "ghcr.io/daemonless/couchdb:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - COUCHDB_USER=admin
      - COUCHDB_PASSWORD=changeme
      - COUCHDB_SINGLE_NODE=true
    volumes:
      - "/containers/couchdb:/config"

Save as bastille-compose.yml, then run bastille up. Open http://<server>:5984 from another machine (the server's own browser can't use a published port).

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container
COUCHDB_USER admin Administrator username created on first start
COUCHDB_PASSWORD changeme Password for COUCHDB_USER (hashed into /config/etc/local.ini on first start; if unset, a random password is saved to /config/admin_password)
COUCHDB_SINGLE_NODE true Automatically create _users and _replicator system databases on startup (set false for multi-node cluster setup)
COUCHDB_SECRET <COUCHDB_SECRET> Cookie authentication signing secret (generated and persisted in /config/etc/local.d/10-secret.ini if unset)
NODENAME `` Erlang node host or IP for multi-node clustering (-name couchdb@NODENAME)
COUCHDB_ERLANG_COOKIE `` Shared Erlang distribution cookie written to /config/.erlang.cookie for clustering

Volumes

Path Description
/config Database files (/config/data) and persistent configuration (/config/etc)

Ports

Port Protocol Description
5984 TCP HTTP API and Fauxton web UI (/_utils/)

First run and Fauxton UI

CouchDB 3.x requires an administrator account. Set COUCHDB_USER and COUCHDB_PASSWORD before first start; CouchDB hashes the password in place in /config/etc/local.ini on boot. If COUCHDB_PASSWORD is omitted, a random password is generated on first start and written to /config/admin_password (mode 0600).

Sign in to the Fauxton web interface at http://<host>:5984/_utils/.

Configuration and persistence

Both database shards (/config/data) and configuration files (/config/etc/local.ini, /config/etc/local.d/*.ini, and /config/etc/vm.args) live under /config, so settings changed through Fauxton or /_config (such as CORS rules for PouchDB or Obsidian LiveSync) persist across container upgrades without extra bind mounts.

COUCHDB_SINGLE_NODE=true is enabled by default so standalone deployments create _users and _replicator automatically on first boot. For a multi-node cluster, set COUCHDB_SINGLE_NODE=false, NODENAME, and a shared COUCHDB_ERLANG_COOKIE, and publish ports 4369 (epmd) and 9100 alongside 5984.

Architectures: amd64, aarch64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1


Need help? Join our Discord community.

Releases

Packages

Contributors

Languages