From 146da7529237b07e8e17a43a69a2d81ebdfbaa3d Mon Sep 17 00:00:00 2001 From: Nils Heumer Date: Thu, 23 Apr 2020 18:46:35 +0200 Subject: [PATCH 1/4] Update readme - Adds some additional infos to readme --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7487e2a..4dfdf2f 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,13 @@ database table relationships and the resulting Hibernate uni- and bi-directional representations. ### Major Tech-Stack -- Spring Boot -- OAuth2 with Keycloak +- Spring Boot and +- OAuth2 +- Keycloak - Hibernate - Lombok +- Rest API - Flyway -- REST Api - RESTEasy - WebFlux - JSP @@ -35,7 +36,15 @@ representations. ## FRONTEND -An appropriate [Angular frontend client](https://github.com/nilsign/angular-demo-fe) is available within my GitHub account. +On localhost:8080 some JSP pages with brief user information can be found which are severed by a +Spring Boot embedded Tomcat. + +An appropriate [Angular frontend client](https://github.com/nilsign/angular-demo-fe) is available +within my GitHub account. To be able to access most of the implemented features, which are mainly +user and role management related, login as a user owning the super admin role. + + Username: `nilsign`
+ Password: `root` ## SETUP @@ -367,6 +376,12 @@ environment. - http://localhost:8080/swagger-ui.html +Note that only authenticated users can reach the Swagger API documentation. So, when there occurs a +redirect from the URL above to the Keycloak login page use the usual credentials. + + Username: `nilsign`
+ Password: `root` + ## POTENTIAL ROAD MAP + RestAPI extensions depending on the concrete FE needs From 9102b0b78e5f15de846c273b489a4ab79aa7214f Mon Sep 17 00:00:00 2001 From: Nils Heumer Date: Fri, 24 Apr 2020 12:23:31 +0200 Subject: [PATCH 2/4] Update readme - Adds new docker images - Adds some minor updates --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4dfdf2f..cee659f 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ database table relationships and the resulting Hibernate uni- and bi-directional representations. ### Major Tech-Stack -- Spring Boot and +- Spring Boot - OAuth2 - Keycloak - Hibernate @@ -62,7 +62,7 @@ To get more used to Keycloak and Docker the manual configuration option is recom For a manual setup of the docker container skip this chapter and instead follow the instructions of the manual configuration. -1. [Download](https://drive.google.com/file/d/1Ovp6dMJ2ZbuEsO03lVeuuDIgr6wG6c_O/view?usp=sharing) +1. [Download](https://drive.google.com/file/d/1Et3nCBDFk-qR39dUSnUlo3Sa1HeUyMFe/view?usp=sharing) a fully pre-configured Docker Keycloak image as tar. 2. Load the tar and then just run it in a Docker container. @@ -226,11 +226,11 @@ DemoProjectRealm->Configure->Clients->Account->"Credentials" 1. (Optional) Commit the running Keycloak Docker container to a new Docker image. $ docker ps -a - $ docker commit [CONTAINER ID] jboss/keycloak:demo-project-v4 + $ docker commit [CONTAINER ID] jboss/keycloak:demo-project-v8 -2. (Requires: 9) To start the new jboss/keycloak:demo-project-v4 Docker image execute +2. (Requires: 9) To start the new jboss/keycloak:demo-project-v8 Docker image execute - $ docker run -p 8100:8080 jboss/keycloak:demo-project-v4 + $ docker run -p 8100:8080 jboss/keycloak:demo-project-v8 3. To start a stopped container (e.g. after reboot, docker update etc...) call start with the container name or id. From a31a7b7107dc09363d34d4f4a4c77e8351bb1dbc Mon Sep 17 00:00:00 2001 From: Nils Heumer Date: Fri, 24 Apr 2020 12:30:16 +0200 Subject: [PATCH 3/4] Update readme - Improves documentation --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cee659f..b625b92 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,8 @@ Spring Boot embedded Tomcat. An appropriate [Angular frontend client](https://github.com/nilsign/angular-demo-fe) is available within my GitHub account. To be able to access most of the implemented features, which are mainly -user and role management related, login as a user owning the super admin role. +user and role management related, navigate to http://localhost:4200 and login as a user with the +super admin role. Username: `nilsign`
Password: `root` From 2a8e90160f47b0037909dc43a724bc148338bde8 Mon Sep 17 00:00:00 2001 From: Nils Heumer Date: Fri, 24 Apr 2020 12:34:06 +0200 Subject: [PATCH 4/4] Update readme - Improves documentation --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b625b92..629cc9f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ One main focus is on Keycloak, which acts as authentication (OpenID Connect) and annotation based role and authority management framework. Be aware, that especially the authorization role model is not necessarily a typical real-world model. The core intention is here to restrict the REST Api to user roles provided by Keycloak and to roles provided by a JPA datasource -(Postgres). +(Postgres) and to provide user and role management functionality. As database a Postgres instance is running also (as Keycloak) in a local Docker container. Note, that the relational model might be as well a bit 'constructed' in order to reflect all relevant @@ -41,8 +41,8 @@ Spring Boot embedded Tomcat. An appropriate [Angular frontend client](https://github.com/nilsign/angular-demo-fe) is available within my GitHub account. To be able to access most of the implemented features, which are mainly -user and role management related, navigate to http://localhost:4200 and login as a user with the -super admin role. +user and role management related, start the frontend locally, navigate to http://localhost:4200 and +login as a user with the super admin role. Username: `nilsign`
Password: `root`