No description
Find a file
Marek Posolda 303bac6832 Merge pull request #155 from hmlnarik/KEYCLOAK-5102-Action-token-documentation
KEYCLOAK-5102 Action token SPI documentation
2017-07-18 15:47:55 +02:00
authorization_services [KEYCLOAK-5126] - Small typo in code snippet 2017-07-04 16:25:10 -03:00
getting_started fixed license for remaining guides 2017-05-02 10:08:21 -04:00
images Initial summary structure for single book 2017-02-14 15:06:18 +01:00
internal_resources Update styleguide.adoc 2017-05-30 13:42:11 -05:00
scripts Add a scripts/buildGuides.sh script and fix individual build scripts 2017-02-27 11:53:10 -05:00
securing_apps Merge pull request #151 from sebastienblanc/KEYCLOAK-5082 2017-07-05 07:25:08 +02:00
server_admin fixes 2017-07-17 15:51:49 -04:00
server_development KEYCLOAK-5102 Action token SPI documentation 2017-07-18 13:01:28 +02:00
server_installation Merge pull request #55 from cainj13/dockerProtocol 2017-06-29 07:25:42 +02:00
.force_build Try to force build 2017-03-16 08:19:08 +01:00
.gitattributes .git files 2016-05-04 11:11:47 -04:00
.gitignore Add documentation for Docker protocol 2017-05-08 11:39:17 -05:00
book-product.json Updates to Docker docs 2017-06-01 15:08:47 +02:00
book.json fix 2017-07-17 17:54:45 -04:00
build-product.sh KEYCLOAK-4424 Add shared scripts and book-product.json to toplevel 2017-04-07 10:07:51 +02:00
gitlab-conversion.py KEYCLOAK-4424 Add shared scripts and book-product.json to toplevel 2017-04-07 10:07:51 +02:00
License.html KEYCLOAK-4506 Added missing ASL2 license file 2017-03-09 13:39:14 +01:00
OVERVIEW.adoc Added instructions on how to build documentation 2017-03-15 13:26:46 +01:00
README.md KEYCLOAK-4424 Add shared scripts and book-product.json to toplevel 2017-04-07 10:07:51 +02:00
SUMMARY.adoc KEYCLOAK-4424 Add shared scripts and book-product.json to toplevel 2017-04-07 10:07:51 +02:00

Keycloak Documentation

Open Source Identity and Access Management for modern Applications and Services.

For more information about Keycloak visit Keycloak homepage and Keycloak blog.

Building Keycloak Documentation

Ensure you have GitBook installed

First clone the Keycloak Documentation repository:

git clone https://github.com/keycloak/keycloak-documentation.git
cd keycloak-documentation

To build Keycloak Documentation run:

gitbook build

You can then view the documentation by opening _book/index.html.

Alternatively you can also have the Gitbook tools continiously re-build when you do changes. To do this run:

gitbook serve

You can then view the documentation on http://localhost:4000.

Building RH-SSO Documentation

Keycloak is the basis of Red Hat Single Sign-On. The same documentation sources are used, but they are built slighty differently.

To build the documentation for RH-SSO go into the directory of the specific guide you want to build. For example to build Server Admin guide run:

cd server_admin
python ../gitlab-conversion.py
cd target
asciidoctor master.adoc

On Linux you can also run build-product.sh DIR. For example:

./build-product.sh server_admin

Or build all guides with:

./build-product.sh

If you have ccutil available you can build the guides with:

./build-product.sh -u

You can then view the documentation by opening server_admin/target/master.html

This will not create documentation that looks exactly as the official Red Hat Single Sign-On documentation, but the content will be the same.

License