Keycloak

Development1024MB+ RAM

Open-source identity and access management

Download Server Compass View Documentation

authidentityssooauth

Deploy Keycloak in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select Keycloak

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

DIY Deployment

Self-Host Keycloak with Docker

Take the DIY route and deploy Keycloak on your own server using Docker.

Access Your VPS Terminal

Use your terminal to securely access your server. You'll need your server's IP address.

terminal

# Connect via SSH
ssh root@your-vps-ip

# Alternative with key file
ssh -i /path/to/key root@your-vps-ip

First time? Make sure Docker is installed on your VPS. Run: curl -fsSL https://get.docker.com | sh

Set Up the Deployment Folder

Initialize a project folder on your server.

terminal

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

Set Up the Stack Definition

Use this Docker Compose configuration for your deployment:

docker-compose.yml

services:
  keycloak:
    image: quay.io/keycloak/keycloak:latest
    ports:
      - "8080:8080"
    environment:
      - KC_BOOTSTRAP_ADMIN_USERNAME=admin
      - KC_BOOTSTRAP_ADMIN_PASSWORD=<your-admin-password>
      - KC_DB=postgres
      - KC_DB_URL=jdbc:postgresql://db:5432/keycloak
      - KC_DB_USERNAME=keycloak
      - KC_DB_PASSWORD=<your-db-password>
    command: start-dev
    restart: unless-stopped
    depends_on:
      db:
        condition: service_healthy

  db:
    image: postgres:16-alpine
    environment:
      - POSTGRES_USER=keycloak
      - POSTGRES_PASSWORD=<your-db-password>
      - POSTGRES_DB=keycloak
    volumes:
      - postgres_data:/var/lib/postgresql/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U keycloak"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  postgres_data:

Configurable Options

PORTHost port(default: 8080)

ADMIN_USERAdmin user(default: admin)

ADMIN_PASSWORDAdmin password

DB_PASSWORDDB password

Start the Containers

Bring up your containers in detached mode.

terminal

# Start all services
docker compose up -d

# List running containers
docker compose ps

# Watch the logs
docker compose logs -f

Set Up Firewall Rules

Allow the application port through your server's firewall.

terminal

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

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

Skip the Terminal

Let Server Compass do the heavy lifting.

Forget SSH and YAML files. Deploy Keycloak visually with Server Compass in just a few clicks.

Beautiful interface
One-click deploys
Let's Encrypt SSL
Zero downtime
Container monitoring
Easy rollbacks

Download Server Compass$29 one-time • Lifetime license

After Deployment

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

Create realms and clients

Need help? Check out our documentation for detailed guides.

Keycloak FAQ

Common questions about self-hosting Keycloak

How do I deploy Keycloak with Server Compass?

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

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

Can I migrate my existing Keycloak data?

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

How do I update Keycloak to the latest version?

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

Is Keycloak free to self-host?

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