CouchDB

Database256MB+ RAM

Seamless multi-master sync with built-in REST API

Download Server Compass View Documentation

databasenosqldocumentsync

Deploy CouchDB in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select CouchDB

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

Terminal Deployment

CouchDB CLI Deployment

Deploy CouchDB the traditional way with SSH and Docker Compose.

Connect to Your Remote Server

Begin by establishing a secure connection to your server through the terminal.

terminal

# Access your VPS
ssh root@YOUR_SERVER_IP

# With SSH key authentication
ssh -i ~/.ssh/your-private-key root@YOUR_SERVER_IP

First time? Ensure Docker is installed first: curl -fsSL https://get.docker.com | sh

Set Up Your App Folder

Create a dedicated folder for your application files.

terminal

# Create and navigate to project directory
mkdir -p ~/apps/couchdb
cd ~/apps/couchdb

Set Up Docker Compose

Create the following docker-compose.yml in your project directory:

docker-compose.yml

services:
  couchdb:
    image: couchdb:3
    ports:
      - "5984:5984"
    environment:
      - COUCHDB_USER=admin
      - COUCHDB_PASSWORD=<your-couchdb-password>
    volumes:
      - couchdb_data:/opt/couchdb/data
      - couchdb_config:/opt/couchdb/etc/local.d
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:5984/"]
      interval: 30s
      timeout: 10s
      retries: 5

volumes:
  couchdb_data:
  couchdb_config:

Deployment Settings

PORTCouchDB port(default: 5984)

COUCHDB_USERAdmin username(default: admin)

COUCHDB_PASSWORDAdmin password

Spin Up the Stack

Run Docker Compose to launch your application.

terminal

# Launch the stack
docker compose up -d

# Verify container status
docker compose ps

# Follow the logs
docker compose logs --follow

Open the Application Port

Configure UFW to allow traffic to your application.

terminal

# Allow the application port through firewall
sudo ufw allow 5984/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:5984

Skip the Terminal

Make it simple with Server Compass.

Server Compass makes deploying CouchDB effortless. Visual setup, one-click deploy, done.

No terminal required
Point-and-click setup
Auto SSL certificates
Rolling deployments
Health monitoring
Instant rollbacks

Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying CouchDB with Server Compass, complete these steps to finish setup

Access Fauxton UI at /_utils

Create databases for your applications

Set up design documents for views and filters

Configure replication if using multiple nodes

Set up monitoring

Configure backup schedules

Need help? Check out our documentation for detailed guides.

CouchDB FAQ

Common questions about self-hosting CouchDB

How do I deploy CouchDB with Server Compass?

Simply download Server Compass, connect to your VPS, and select CouchDB from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for CouchDB?

CouchDB requires a minimum of 256MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing CouchDB data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard CouchDB backup and restore procedures.

How do I update CouchDB to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest CouchDB image will be pulled and deployed with zero downtime.

Is CouchDB free to self-host?

CouchDB is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.