Level: Beginner
Technologies: HTML5, JavaScript
Summary: HTML5 Profile Application packaged as a WAR
Target Product: Keycloak, WildFly
Source: https://github.com/keycloak/keycloak-quickstarts
The app-profile-jee-html5
quickstart demonstrates how to write an application with HTML5 and JavaScript that
authenticates using Keycloak. Once authenticated the application shows the user's profile information and can also
display the token retrieved from Keycloak.
For simplicity of deploying the application it is packaged as a WAR archive and can be deployed to WildFly.
As the example only contains static html pages the files in src/main/webapp
can also be hosted on any web server.
If you are deploying the application as a WAR you need to have WildFly 10 running.
All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.1.1 or later.
Prior to running the quickstart you need to create a client in Keycloak and download the installation file.
The following steps show how to create the client required for this quickstart:
- Open the Keycloak admin console
- Select
Clients
from the menu - Click
Create
- Add the following values:
- Client ID: You choose (for example
app-profile-html5
) - Client Protocol:
openid-connect
- Root URL: URL to the application (for example
http://localhost:8080/app-profile-html5
)
- Client ID: You choose (for example
- Click
Save
Once saved you need to change the Access Type
to public
and click save.
If you deploy the application somewhere else change the hostname and port of the URLs accordingly.
Finally you need to configure the javascript adapter, this is done by retrieving the adapter configuration file:
- Click on
Installation
in the tab for the client you created - Select
Keycloak OIDC JSON
- Click
Download
- Move the file
keycloak.json
to thesrc/main/webapp/
directory in the root of the quickstart
As an alternative you can create the client by importing the file client-import.json and
copying config/keycloak-example.json to src/main/webapp/keycloak.json
.
-
Open a terminal and navigate to the root directory of this quickstart.
-
The following shows the command to deploy the quickstart:
mvn install wildfly:deploy
You can access the application with the following URL: http://localhost:8080/app-profile-html5.
-
Open a terminal and navigate to the root directory of this quickstart.
-
The following shows the command to undeploy the quickstart:
mvn wildfly:undeploy