Skip to content

Commit be4c863

Browse files
committed
other(doc): Minor adjustements
1 parent f0e8779 commit be4c863

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

README.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,21 @@ This workshop is based the following article [Keycloak integration with OpenFGA
1111
The following diagram illustrates the solution architecture of this workshop:
1212

1313
<p align="center">
14-
<img width="70%" height="70%" src="doc/images/solution-architecture.png">
14+
<img width="80%" height="80%" src="doc/images/solution-architecture.png">
1515
</p>
1616

1717
* Core:
1818
* Keycloak is responsible for handling the authentication with the standard OpenID Connect and manages user access with its Role Model.
19-
* Keycloak is configured with a new custom extension :rocket: [keycloak-openfga-event-publisher](https://github.com/embesozzi/keycloak-openfga-event-publisher) which listens to the Keycloak events (User Role Assignment, Role to Role Assignment, etc), parses this event into an OpenFGA tuple based on the [Keycloak Authorization Schema](model.dsl) and publishes them to OpenFGA over HTTP.
19+
* Keycloak is configured with a new custom extension ❤️: [keycloak-openfga-event-publisher](https://github.com/embesozzi/keycloak-openfga-event-publisher)
20+
* Listens to the Keycloak events (User Role Assignment, Role to Role Assignment, etc).
21+
* Parses this event into an OpenFGA tuple key based on the [Keycloak Authorization Schema](model.dsl).
22+
* Publishes them to OpenFGA over HTTP using the [OpenFGA Java SDK](https://github.com/openfga/java-sdk).
2023
* OpenFGA is responsible for applying fine-grained access control. The OpenFGA service answers authorization checks by determining whether a relationship exists between an object and a user.
2124
* Other components
2225
* Store Web Application is integrated with Keycloak by OpenID Connect
2326
* Store API is protected by OAuth 2.0 and it utilizes the OpenFGA SDK for FGA
2427

28+
2529
# How to install?
2630
## Prerequisites
2731

@@ -49,12 +53,12 @@ The following diagram illustrates the solution architecture of this workshop:
4953

5054
4. Access the following web UIs using URLs bellow via a web browser.
5155

52-
| Component | URI | Username | Password | Image |
53-
| ------------------------- |:-----------------------------:|:-----------:|:-----------:|:-----------:
54-
| Keycloak Console | http://keycloak:8081 | admin | password | quay.io/keycloak/keycloak:19.0.2 |
55-
| OpenFGA Playground | http://localhost:3000/playground | | | openfga/openfga:latest |
56-
| Store Portal | http://store:9090 | | | Custom image |
57-
| Store API | http://store-api:9091 | | | Custom image |
56+
| Component | URI | Credential | Image |
57+
| ------------------------- |:-----------------------------:|:-------------------------:|:-----------:
58+
| Keycloak Console | http://keycloak:8081 | admin / password | quay.io/keycloak/keycloak:19.0.2 |
59+
| OpenFGA Playground | http://localhost:3000/playground | | openfga/openfga:latest |
60+
| Store Portal | http://store:9090 | | Custom image |
61+
| Store API | http://store-api:9091 | | Custom image |
5862

5963

6064
## Post configuration steps
@@ -72,7 +76,6 @@ The following diagram illustrates the solution architecture of this workshop:
7276
### Keycloak
7377
1. Enable the Keycloak OpenFGA Event Listener extension in Keycloak:
7478

75-
7679
* Open [administration console](http://keycloak:8081)
7780
* Choose realm
7881
* Realm settings

doc/images/solution-architecture.png

4.95 KB
Loading

0 commit comments

Comments
 (0)