Skip to content
Star Fork

Installation

keycloak-config-cli can be installed and run in multiple ways depending on your environment and preferences.

Prerequisites

  • Java 17 or higher
  • Access to a Keycloak server

Installation Methods

The easiest way to run keycloak-config-cli is using Docker:

docker run --rm \
  -e KEYCLOAK_URL=https://your-keycloak-server.com \
  -e KEYCLOAK_USER=admin \
  -e KEYCLOAK_PASSWORD=admin \
  -v /path/to/your/config:/config \
  adorsys/keycloak-config-cli:latest

Docker Compose

For more complex setups, you can use Docker Compose:

version: '3.8'
services:
  keycloak-config-cli:
    image: adorsys/keycloak-config-cli:latest
    environment:
      KEYCLOAK_URL: https://your-keycloak-server.com
      KEYCLOAK_USER: admin
      KEYCLOAK_PASSWORD: admin
      IMPORT_PATH: /config
    volumes:
      - ./config:/config

Manual Download

You can download the latest JAR file from the GitHub releases:

wget https://github.com/adorsys/keycloak-config-cli/releases/latest/download/keycloak-config-cli.jar
java -jar keycloak-config-cli.jar

Build from Source

If you want to build from source:

git clone https://github.com/adorsys/keycloak-config-cli.git
cd keycloak-config-cli
./mvnw clean package
java -jar target/keycloak-config-cli.jar

Homebrew (macOS)

For macOS users, you can install via Homebrew:

brew tap adorsys/keycloak-config-cli
brew install keycloak-config-cli

Configuration

keycloak-config-cli can be configured through:

  • Environment variables
  • Command line arguments
  • Configuration files
  • Spring Boot properties

Environment Variables

Key environment variables include:

  • KEYCLOAK_URL: URL of your Keycloak server
  • KEYCLOAK_USER: Admin username
  • KEYCLOAK_PASSWORD: Admin password
  • IMPORT_PATH: Path to configuration files
  • IMPORT_VAR_SUBSTITUTION_ENABLED: Enable variable substitution

Command Line Arguments

java -jar keycloak-config-cli.jar \
  --keycloak.url=https://your-keycloak-server.com \
  --keycloak.user=admin \
  --keycloak.password=admin \
  --import.path=/path/to/config

Verification

To verify your installation:

java -jar keycloak-config-cli.jar --version

This should display the version information and confirm that the CLI is properly installed.

Next Steps