Skip to content

Commit 0f0389b

Browse files
committed
updated readme to reflect availability for keycloak support in this framework
1 parent 53516c7 commit 0f0389b

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ The framework provides support for the following features:
4141
- Database-backed user store using Spring JPA.
4242
- SSO support for Google
4343
- SSO support for Facebook
44+
- SSO support for Keycloak
4445
- Configuration options to control anonymous access, whitelist URIs, and protect specific URIs requiring a logged-in user session.
4546
- CSRF protection enabled by default, with example jQuery AJAX calls passing the CSRF token from the Thymeleaf page context.
4647
- Audit event framework for recording and logging security events, customizable to store audit events in a database or publish them via a REST API.
@@ -102,7 +103,7 @@ The framework sends emails for verification links, forgot password flow, etc...
102103

103104

104105
### SSO OAuth2 with Google and Facebook
105-
The framework supports SSO OAuth2 with Google and Facebook. To enable this you need to configure the client id and secret for each provider. This is done in the application.yml (or application.properties) file using the [Spring Security OAuth2 properties](https://docs.spring.io/spring-security/reference/servlet/oauth2/login/core.html). You can see the example configuration in the Demo Project's `application.yml` file.
106+
The framework supports SSO OAuth2 with Google, Facebook and Keycloak. To enable this you need to configure the client id and secret for each provider. This is done in the application.yml (or application.properties) file using the [Spring Security OAuth2 properties](https://docs.spring.io/spring-security/reference/servlet/oauth2/login/core.html). You can see the example configuration in the Demo Project's `application.yml` file.
106107

107108
Here is a quick example for your reference:
108109

@@ -120,9 +121,13 @@ spring:
120121
client-id: YOUR_FACEBOOK_CLIENT_ID
121122
client-secret: YOUR_FACEBOOK_CLIENT_SECRET
122123
redirect-uri: "{baseUrl}/login/oauth2/code/facebook"
124+
keycloak:
125+
client-id: YOUR_KEYCLOAK_CLIENT_ID
126+
client-secret: YOUR_KEYCLOAK_CLIENT_SECRET
127+
redirect-uri: "{baseUrl}/login/oauth2/code/keycloak"
123128
```
124129
125-
For public OAuth you will need a public hostname and HTTPS enabled. You can use ngrok or Cloudflare tunnels to create a public hostname and tunnel to your local machine during development. You can then use the ngrok hostname in your Google and Facebook developer console configuration.
130+
For public OAuth you will need a public hostname and HTTPS enabled. You can use ngrok or Cloudflare tunnels to create a public hostname and tunnel to your local machine during development. You can then use the ngrok hostname in your Google, Facebook and Keycloak developer console configuration.
126131
127132
128133

0 commit comments

Comments
 (0)