keycloak-config-cli

(โ˜… 1,178)

Import YAML/JSON-formatted configuration files into Keycloak - Configuration as Code for Keycloak.

  • .codacy.yaml
  • .edge-build.Dockerfile
  • .editorconfig
  • .env
  • .gitignore
  • build-readme.md
  • CHANGELOG.md
  • checkstyle.xml
  • CODE_OF_CONDUCT.md
  • codecov.yml
  • CONTRIBUTING.md
  • docker-compose.yml
  • Dockerfile
  • DOCUMENTATION.md
  • LICENSE.txt
  • mvnw
  • mvnw.cmd
  • pom.xml
  • README.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/adorsys/keycloak-config-cli

Downloads the entire project code from GitHub to your computer.

cd keycloak-config-cli

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run --rm \

Runs the built image as an actual container.

We are using [TestContainers](https://www.testcontainers.org/) in our integration tests. To run the integration tests a configured docker environment

Type this command into your terminal and run it.

A docker images is available at [DockerHub](https://hub.docker.com/r/adorsys/keycloak-config-cli) (docker.io/adorsys/keycloak-config-cli)

Type this command into your terminal and run it.

Available docker tags

Type this command into your terminal and run it.

For docker `-e` you have to replace dots with underscores.

Type this command into your terminal and run it.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
cd contrib/custom-representations

This project's files live in a subfolder, so move into it first.

mvn clean install

Installs dependencies and builds the project using Maven.

โœ… A BUILD SUCCESS message means it worked. The output is created under target/.
// repository documentation