OAuth with Keycloak/Red Hat SSO (self-hosted)¶
This guide assumes you have run and configured Keycloak. If you'd like to meet this prerequisite quickly, it can be achieved by running a
jboss/keycloak container and attaching it to your network. Set the environment variables KEYCLOAK_USER and
KEYCLOAK_PASSWORD, and expose port 8080.
Where HTTPS is specified throughout, use HTTP instead. You may also have to specify the exposed port, 8080.
- Sign in to the administration portal for your Keycloak instance at https://keycloak.example.com/auth/admin/master/console
You may note that a separate realm is specified throughout this tutorial. It is best practice not to use the master realm, as it normally contains the realm-management client that federates access using the policies and permissions you can create.
- Navigate to the client management page at
https://keycloak.example.com/auth/admin/master/console/#/realms/your-realm/clients(admin permissions required)
- Click Create to create a new client and fill out the registration form. You should set the Root URL to the fully qualified public URL of your HedgeDoc instance.
- Click Save
- Set the Access Type of the client to
confidential. This will make your client require a client secret upon authentication.
Additional steps to circumvent generic OAuth2 issue¶
- Select Client Scopes from the sidebar, and begin to create a new client scope using the Create button.
- Ensure that the Name field is set to
- Create a new mapper under the Mappers tab. This should reference the User Property
Claim JSON Typeshould be String and all switches below should be enabled. Save the mapper.
- Go to the client you set up in the previous steps using the Clients page, then choose the Client Scopes tab. Apply the scope you've created. This should mitigate errors as seen in hedgedoc/hedgedoc#56, as the
/userinfoendpoint should now bring back the user's ID under the
idkey as well as
- In the
docker-compose.ymladd the following environment variables to
CMD_OAUTH2_USER_PROFILE_URL=https://keycloak.example.com/auth/realms/your-realm/protocol/openid-connect/userinfo CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR=preferred_username CMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR=name CMD_OAUTH2_USER_PROFILE_EMAIL_ATTR=email CMD_OAUTH2_TOKEN_URL=https://keycloak.example.com/auth/realms/your-realm/protocol/openid-connect/token CMD_OAUTH2_AUTHORIZATION_URL=https://keycloak.example.com/auth/realms/your-realm/protocol/openid-connect/auth CMD_OAUTH2_CLIENT_ID=<your client ID> CMD_OAUTH2_CLIENT_SECRET=<your client secret, which you can find under the Credentials tab for your client> CMD_OAUTH2_PROVIDERNAME=Keycloak CMD_OAUTH2_SCOPE=openid email profile CMD_DOMAIN=<hedgedoc.example.com> CMD_PROTOCOL_USESSL=true CMD_URL_ADDPORT=false
docker-compose up -dto apply your settings.
- Sign in to your HedgeDoc using your Keycloak ID