1
Step 1Open the server Apps tab
Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.
Back to all templates
CouchDB
Database256MB+ RAM
Seamless multi-master sync with built-in REST API
databasenosqldocumentsync
Deploy CouchDB in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select CouchDB
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy CouchDB on a VPS with Server Compass
Use the CouchDB template in Server Compass to deploy a document database with persistent storage on your VPS, then verify the HTTP API from inside the container.
About 10 minutesBrowser verified
2
Step 2Choose an app template
Click New App and choose the template deployment path so Server Compass can load the built-in catalog.
3
Step 3Search for CouchDB
Use the template picker search to find CouchDB in the Server Compass template catalog.
4
Step 4Select the CouchDB template
Choose the CouchDB template. Server Compass fills the CouchDB container, persistent data and config volumes, host port, admin username, and generated password.
5
Step 5Review the CouchDB settings
Confirm the app name and compose service. In this run, the app was named couchdb-demo and used host port 5984.
6
Step 6Deploy CouchDB
Review the generated environment values, keep the CouchDB admin password masked, confirm the HTTP port is available, and click Deploy Now.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the CouchDB image, starts the container, and verifies the stack.
8
Step 8Confirm CouchDB is running
After deployment finishes, return to the Apps tab and confirm the CouchDB app is marked Running with the database port available.
9
Step 9Verify CouchDB is reachable
Open the app detail view and verify the running CouchDB container. In this tutorial run, an authenticated request to the local CouchDB API returned the expected welcome response without exposing the generated password.
After CouchDB Opens
- Store the generated CouchDB admin password in a secure password manager.
- Create application-specific databases and users before production use.
- Restrict external access to port 5984 unless remote clients explicitly need it.
- Configure regular backups for the CouchDB data volume before storing production data.
- Use HTTPS through a reverse proxy before exposing Fauxton or the API publicly.
Verified Result
The CouchDB container returned a successful API response from an authenticated internal curl request.
CouchDB deployment questions
What does the CouchDB template deploy?
It deploys a CouchDB container with persistent data and config volumes, an admin username, and a generated admin password.
Which port did the tutorial use?
The tutorial used host port 5984, which maps to CouchDB container port 5984.
Why is there no browser verification screenshot?
CouchDB includes the Fauxton web UI, but the tutorial verifies the database service with an authenticated internal API request so no admin password is shown in a browser screenshot.
Should this become a blog post?
No. The deployment guide should live on the CouchDB template detail page and be linked from the reusable template deployment docs page.
Terminal Deployment
CouchDB CLI Deployment
Deploy CouchDB the traditional way with SSH and Docker Compose.
1
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_IPFirst time? Ensure Docker is installed first: curl -fsSL https://get.docker.com | sh
2
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/couchdb3
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 password4
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 --follow5
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:5984Skip 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
1
Access Fauxton UI at /_utils
2
Create databases for your applications
3
Set up design documents for views and filters
4
Configure replication if using multiple nodes
5
Set up monitoring
6
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.
Ready to Self-Host CouchDB?
Download Server Compass and deploy CouchDB to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass