Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Bartoš <mabartos@redhat.com>
  • Loading branch information
mabartos committed Feb 4, 2025
1 parent e393bac commit 646f615
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 14 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
7 changes: 0 additions & 7 deletions docs/building-source.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 646f615

Please sign in to comment.