https://github.com/dteleguin/beercloak

BeerCloak: a comprehensive Keycloak extension example
https://github.com/dteleguin/beercloak

keycloak

Last synced: about 1 month ago
JSON representation

BeerCloak: a comprehensive Keycloak extension example

• Host: GitHub
• URL: https://github.com/dteleguin/beercloak
• Owner: dteleguin
• Created: 2016-10-31T10:53:01.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-08-22T14:10:44.000Z (10 months ago)
• Last Synced: 2024-02-10T10:11:29.658Z (5 months ago)
• Topics: keycloak
• Language: Java
• Homepage:
• Size: 324 KB
• Stars: 124
• Watchers: 7
• Forks: 28
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Lists

• awesome-keycloak - BeerCloak: a comprehensive KeyCloak extension example

README

        
# BeerCloak: a comprehensive Keycloak extension example

BeerCloak is a collection of different techniques for building custom admin resources in Keycloak.

* `BeerEntity` JPA entity + LiquiBase changelog;

* `BeerResource` realm REST resource with CRUD operations & more;

* Authorization:

  * roles: `view-beer` and `manage-beer`;

  * automatically created for each existing realm;

  * automatically created for each newly added realm;

  * automatically included into the master `admin` role;

  * used for authorization on `BeerResource` and sub-resources;

* Event logging:

  * AdminEventBuilder instance;

  * custom resource and action types (not yet implemented)

* GUI extensions to the admin console.

The `beercloak.resources.AbstractAdminResource` is ready to be used as a base class for admin resources. It contains the code necessary to setup authorization and logging.

### Structure

`beercloak-core`: "core" module with some "business logic", to demonstrate packaging with dependencies  

`beercloak-module`: main module actually containing providers and everything (depends on `beercloak-core`)  

`beercloak-ear`: EAR packaging module to combine all the above into a deployable EAR 

## Requirements

* Keycloak 3.4.0.Final

## Build

`mvn install`

## Installation

1. Copy `beercloak-ear/target/beercloak-XXX.ear` into Keycloak's `standalone/deployments` directory.

**Warning!** While Keycloak generally supports hot deployment of providers, this is *not supported* for EntityProviders.

That means, BeerCloak shouldn't be hot (re)deployed, otherwise you'll get exceptions and non-working code.  

See [KEYCLOAK-5782](https://issues.jboss.org/browse/KEYCLOAK-5782) for more info.

2. Configure theme in your `standalone/configuration/standalone.xml`:

```xml

        

            ...

            

                2592000

                true

                true

                ${jboss.home.dir}/themes

                

                

                    

                        deployment.beercloak

                    

                

                beer

            

            ...

        

 ```

 

 You can omit `beer`, but then you'll have to manually choose the "beer" theme in realm configuration → Themes → Admin console theme.

 

(Currently, if you ship a theme inside your module, you have to configure it manually in the XML config. This may change in the future with automatic deployment of themes, you can track progress under [KEYCLOAK-4547](https://issues.jboss.org/browse/KEYCLOAK-4547))

## Running example

Run Keycloak and log into the admin console. You should be able to access the "Beer" menu item.