[keycloak-dev] [keycloak-user] Keycloak documentation

Marek Posolda mposolda at redhat.com
Fri May 15 01:35:44 EDT 2015


Hi,

Keycloak implements OpenID Connect and SAML specifications from both 
client and server perspective. You can find some diagrams related to 
those specs on the web.

Client (adapters) code is inside "integration" module and it's 
submodules. Then in "core" module is some shared code for both adapters 
and server. The rest of the code are mainly server parts. For the 
server, you can start to look at KeycloakApplication class, which is 
entry point where are registered REST resources and 
KeycloakSessionFactory, which registers SPIs. That's for the start. For 
the rest, I would suggest to dig into code, debug and see how it works :-)

ah, and some startup docs for developers is also in readme files under 
"misc" directory (you can take a look at least to HackingOnKeycloak.md 
and Testsuite.md ). Good luck:-)

Marek

On 15.5.2015 06:41, Carlos Feria wrote:
>
> Hello. I'm using keycloak in my projects, it is a great solution.
>
> I'd would like to find some documentation of the structure or 
> architecture of keycloak, something like uml diagrams or any 
> documentation for developers not only for users...
>
> i'm trying to review the code for learn how keycloak works internally. 
> Please, anybody could tell me if exists anything like.
>
>
>
> _______________________________________________
> keycloak-user mailing list
> keycloak-user at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/keycloak-user

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/keycloak-dev/attachments/20150515/93e5310a/attachment.html 


More information about the keycloak-dev mailing list