Deploying Docker Engine on Linux

Before you can install and run Keycloak in a Docker container on a linux system (or systems), you need to verify your system meets the following prerequisites and perform the following pre-deployment steps.

Docker-Specific Software Requirements for Keycloak on Linux Systems

note

See the Prerequisites page for information about the required hardware and memory for Keycloak.

Software	Version
Ubuntu LTS Linux (64-bit)	22/24
Docker Engine	Engine up-to-date. See the Install Docker Engine guide for information about installing Docker Engine.
Docker Compose	Compose 2.23.0 or higher

Installation and Pre-Deployment Checklist

info

The examples below uses Ubuntu 24.04.1 as a reference. For other operating systems, the process is essentially the same. Refer to the official documentation link above.

Install the Docker Engine

Install the Docker Engine on the linux system where you plan to run the Docker container that will host Eggplant IAM.

note

You can copy the command examples in this document by hovering over the right-side of the example to display a Copy button and then clicking it.

1. Download the required software. Refer to the Software Requirements table above for the list of what you need.

2. In a terminal, install Docker Engine using the following script. For more information, see Install Docker Engine in the Docker documentation.

   # Add Docker's official GPG key:
   sudo apt-get -y update
   sudo apt-get -y install ca-certificates curl
   sudo install -m 0755 -d /etc/apt/keyrings
   sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
   sudo chmod a+r /etc/apt/keyrings/docker.asc
   
   # Add the repository to Apt sources:
   echo \
     "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
     $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
     sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
   sudo apt-get update
   
   sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
   
   sudo usermod -aG docker ubuntu
   newgrp docker

3. Verify the Docker Engine installation by running the following command:

   docker run --rm hello-world

4. Compare the expected output below with the output on your system. The output below (from the command in the previous step) shows a successful Docker Engine installation and configuration.

   Hello from Docker!
   
   This message shows that your installation appears to be working correctly.
   
   To generate this message, Docker took the following steps:
   
   1. The Docker client contacted the Docker daemon.
   
   2. The Docker daemon pulled the "hello-world" image from the Docker Hub.
   
   (arm64v8)
   
   3. The Docker daemon created a new container from that image which runs the
      executable that produces the output you are currently reading.
   
   4. The Docker daemon streamed that output to the Docker client, which sent it
      to your terminal.
   
   To try something more ambitious, you can run an Ubuntu container with:
   
   $ docker run -it ubuntu bash
   
   Share images, automate workflows, and more with a free Docker ID:
   
   https://hub.docker.com/
   
   For more examples and ideas, visit:
   
   https://docs.docker.com/get-started/

Next Step: Deploying Eggplant IAM with Docker

After you install and verify your Docker Engine installation, and complete the pre-deployment checklist, continue to Deploying Eggplant IAM with Docker to install and deploy Eggplant IAM.