Back to all templates
KeyDB logo

KeyDB

Database128MB+ RAM

High-performance Redis-compatible database with multithreading

databasecacheredis-compatiblemultithreaded

Deploy KeyDB in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select KeyDB

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy KeyDB on a VPS with Server Compass

Use the KeyDB template in Server Compass to deploy a persistent KeyDB multi-threaded Redis-compatible data store on your VPS, then verify it with keydb-cli.

About 10 minutesBrowser verified
1
Step 1

Open 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.

Server Compass Apps tab before creating a KeyDB app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for KeyDB

Use the template picker search to find KeyDB in the Server Compass template catalog.

Searching for KeyDB in the Server Compass template picker
4
Step 4

Select the KeyDB template

Choose the KeyDB template. Server Compass fills the KeyDB container, persistent data volume, host port, two worker threads, and append-only persistence command.

KeyDB template selected in Server Compass
5
Step 5

Review the KeyDB settings

Confirm the app name and compose service. In this run, the app was named keydb-demo and used host port 6379.

Reviewing KeyDB project settings and compose services
6
Step 6

Deploy KeyDB

Review the generated settings, confirm the KeyDB port is available, and click Deploy Now.

Reviewing KeyDB environment variables and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the KeyDB image, starts the container, and verifies the stack.

Server Compass deploying the KeyDB template on the VPS
8
Step 8

Confirm KeyDB is running

After deployment finishes, return to the Apps tab and confirm the KeyDB app is marked Running with the database port available.

KeyDB template running in the Server Compass Apps tab
9
Step 9

Verify KeyDB is reachable

Open the app detail view and verify the running KeyDB container. In this tutorial run, keydb-cli returned PONG from inside the deployed container.

KeyDB app detail screen after verifying the deployed database container

After KeyDB Opens

  • Decide whether KeyDB should remain private to the VPS or be exposed to a trusted application network.
  • Use firewall rules to restrict access before opening the KeyDB port externally.
  • Restrict external access to port 6379 unless remote clients explicitly need it.
  • Configure regular backups for the KeyDB data volume before storing production data.
  • Review persistence and eviction settings before production use.

Verified Result

The KeyDB container returned PONG from keydb-cli inside the deployed container.

KeyDB deployment questions

What does the KeyDB template deploy?

It deploys a KeyDB container with append-only persistence enabled and a persistent Docker volume mounted at /data.

Which port did the tutorial use?

The tutorial used host port 6379, which maps to KeyDB container port 6379.

Why is there no browser verification screenshot?

KeyDB is a data store service, not a web application. The tutorial verifies it with keydb-cli inside the running container instead of opening a browser page.

Should this become a blog post?

No. The deployment guide should live on the KeyDB template detail page and be linked from the reusable template deployment docs page.

Manual Setup Guide

Set Up KeyDB from Terminal

Get your hands dirty: manual KeyDB deployment guide for developers.

1

Connect to Your VPS via SSH

Fire up your terminal application and establish a connection to your remote server.

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

2

Initialize Project Folder

Create a folder to house your Docker Compose configuration.

terminal
# Create and navigate to project directory
mkdir -p ~/apps/keydb
cd ~/apps/keydb
3

Create Docker Configuration

Define your services in a docker-compose.yml file:

docker-compose.yml
services:
  keydb:
    image: eqalpha/keydb:latest
    ports:
      - "6379:6379"
    volumes:
      - keydb_data:/data
    command: keydb-server --appendonly yes --server-threads 2
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "keydb-cli", "ping"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  keydb_data:
Environment Variables
PORTHost port(default: 6379)
4

Execute the Deployment

Start your containers and verify they're running correctly.

terminal
# Launch the stack
docker compose up -d

# Verify container status
docker compose ps

# Follow the logs
docker compose logs --follow
5

Allow Network Access

Update UFW rules to allow traffic on the application port.

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

# Access your app at:
# http://your-server-ip:6379
Skip the Terminal

Don't want to type commands? We've got you.

Why type commands when you can click? Deploy KeyDB the easy way with Server Compass.

  • 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 KeyDB with Server Compass, complete these steps to finish setup

1

Test connection with redis-cli

2

Configure authentication

3

Tune server-threads based on CPU cores

Need help? Check out our documentation for detailed guides.

KeyDB FAQ

Common questions about self-hosting KeyDB

How do I deploy KeyDB with Server Compass?

Simply download Server Compass, connect to your VPS, and select KeyDB 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 KeyDB?

KeyDB requires a minimum of 128MB 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 KeyDB data?

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

How do I update KeyDB to the latest version?

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

Is KeyDB free to self-host?

KeyDB 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 KeyDB?

Download Server Compass and deploy KeyDB to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass