===== Keycloak Docker-based installation - windows and linux =====

===== Prerequisites (Common for Both) =====

Before Keycloak:

^Tool^Required|
|Docker|✅|
|Docker Compose (optional)|✅|
|Port 8080 free|✅|

Recommended Folder Structure (Both OS)
<code>

iam/
├─ keycloak/
│   ├─ docker-compose.yml
│   ├─ realm-export.json
│   └─ themes/
└─ scripts/
   └─ user-import/

</code>




====== Keycloak Installation on Windows ======


===== Install Docker Desktop (Windows) =====

  - Download Docker Desktop:[[https://www.docker.com/products/docker-desktop/|https://www.docker.com/products/docker-desktop/]]
  - During installation:
  * Enable **WSL 2**
  * Enable **Hyper-V**  (if asked)

3. Restart system

4. Verify:
<code>

docker --version
docker compose version

</code>
===== Keycloak Installation on   Linux (Ubuntu / RHEL / Amazon Linux)   =====

==== Install Docker ====

**ubuntu**
<code>
sudo apt update
sudo apt install -y docker.io
sudo systemctl start docker
sudo systemctl enable docker

</code>


==== Pull Keycloak Image ====

<code>
docker pull quay.io/keycloak/keycloak:24.0.1

</code>

Verify:

<code>
docker images

</code>

Run Keycloak (Development Mode)

<code>
docker run -d ^
--name keycloak ^
-p 8080:8080 ^
-e KEYCLOAK_ADMIN=admin ^
-e KEYCLOAK_ADMIN_PASSWORD=admin ^
quay.io/keycloak/keycloak:24.0.1 ^
start-dev

</code>

Access Keycloak

<code>
http://localhost:8080

</code>

Login:

<code>
username: admin
password: admin

</code>