diff --git a/README.md b/README.md index ce6b6c4..14954ec 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,32 @@ - **OpenAI ChatGPT** - (preview) - **IBM Granite** - (experimental) -For more information, refer to the [README](adaptive/README.md) in `adaptive` module. +For more information, refer to the [Start guide](docs/start.md). + +## Connected Authentication Policies +**NOTE**: Authentication policies that were part of this Adaptive authentication initiative were moved to repository [mabartos/keycloak-authn-policies](https://github.com/mabartos/keycloak-authn-policies). ## Getting started +### Building from Source + +To build it from source, execute this command: +```shell +./mvnw clean install -DskipTests +``` + +If you want to try it out, execute this command: +```shell +./mvnw exec:exec@start-server +``` + +And access `localhost:8080/realms/adaptive/account`. + ### Container +**NOTE**: This is an old release with the authentication policies that are not part of this repository anymore. +Recommended way is to build it from source for now. + You can use the container image by running: podman run -p 8080:8080 quay.io/mabartos/keycloak-adaptive-all start @@ -25,12 +45,6 @@ In order to see the functionality in action, navigate to `localhost:8080/realms/ ℹ️ **INFO:** If you have installed Docker, use `docker` instead of `podman`. -### Building from Source - -To build from source every module, refer to particular READMEs, or follow [building and working with the code base](docs/building-source.md) guide. - -## Connected Authentication Policies -Authentication policies that were part of this Adaptive authentication initiative were moved to repository [mabartos/keycloak-authn-policies](https://github.com/mabartos/keycloak-authn-policies). ## Resources with more info diff --git a/docs/building-source.md b/docs/building-source.md deleted file mode 100644 index ed41fc6..0000000 --- a/docs/building-source.md +++ /dev/null @@ -1,7 +0,0 @@ -## Build the project - -To build the whole project, execute this command: - -```shell -./mvnw clean install -DskipTests -``` \ No newline at end of file diff --git a/docs/start.md b/docs/start.md index 60bb618..e408b9f 100644 --- a/docs/start.md +++ b/docs/start.md @@ -6,6 +6,8 @@ It leverages risk-based authentication, and communicate with OpenAI ChatGPT NPL ## Start the distribution with the extension +You need to + You can simply execute this command in this module and a Keycloak distribution with this extension will start: ```shell ../mvnw exec:exec@start-server