Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 5.95 KB

README.md

File metadata and controls

111 lines (76 loc) · 5.95 KB
Raw

🚀 Try it for free in Phase Two's Keycloak as a service.

Phase Two Admin Portal

More self-serve. More better.

The Phase Two Admin Portal ties together functionality from the Keycloak Account Console and Phase Two Organizations to allow your customers' users to self-manage as much of their account and organization functionality as is possible.

The Portal is deployed as a Keycloak extension, much like the Account Console, and is available at https://{host}/{relative-path}/realms/{realm}/portal/. Note that we are considering making this a drop-in replacement for the Account Console that can be selected simply in Realm Settings->Themes, but this would make it impossible to use both at the same time.

ezgif-4-811bfaae78

Quick start

The easiest way to get started is our Docker image. Documentation and examples for using it are in the phasetwo-containers repo. The most recent version of this extension is included.

docker run --name phasetwo_test --rm -p 8080:8080 \
    -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin -e KC_HTTP_RELATIVE_PATH=/auth \
    quay.io/phasetwo/phasetwo-keycloak:$VERSION \
    start-dev --spi-email-template-provider=freemarker-plus-mustache --spi-email-template-freemarker-plus-mustache-enabled=true

Configuration

Requirements

Because this extension relies on the APIs provided by the keycloak-orgs extension, it is required to deploy them in the same Keycloak.

Visibility

Most of the visibility of functionality in the Portal is controlled by user permissions. However, it is also possible to control visibility through Realm Attributes. These attributes may be set manually, or by using the Phase Two extensions to the Keycloak Admin UI (Styles->Portal tab), which must also be installed in the same Keycloak.

image

When setting the attributes manually, the values are:

Key Description Default
_providerConfig.portal.profile.enabled Profile section (whole) true
_providerConfig.portal.profile.password.enabled Password update true
_providerConfig.portal.profile.twofactor.enabled 2fa create/update true
_providerConfig.portal.profile.activity.enabled Device activity true
_providerConfig.portal.profile.linked.enabled Linked accounts true
_providerConfig.portal.org.enabled Organizations section (whole) true
_providerConfig.portal.org.details.enabled Details edit true
_providerConfig.portal.org.members.enabled Members list true
_providerConfig.portal.org.invitations.enabled Invitations true
_providerConfig.portal.org.domains.enabled Domains true
_providerConfig.portal.org.sso.enabled SSO (requires idp-wizard extension) true
_providerConfig.portal.org.events.enabled Events true

Style

It is also possible to add branding to the portal. It is recommended these, along with logos, are set through the Phase Two extensions to the Keycloak Admin UI, as there are other options there that are reused in Login forms styling, and the UI extensions also ensure that the attributes are set with appropriate values.

These style keys are built off of the Tailwind color formatting. The order of lowest color being lightest and highest color being darkest.

The keys specific to the Portal are:

Key Description Default
_providerConfig.assets.portal.primary100 Primary color - 100 [empty]
_providerConfig.assets.portal.primary200 Primary color - 200 [empty]
_providerConfig.assets.portal.primary400 Primary color - 400 [empty]
_providerConfig.assets.portal.primary500 Primary color - 500 [empty]
_providerConfig.assets.portal.primary600 Primary color - 600 [empty]
_providerConfig.assets.portal.primary700 Primary color - 700 [empty]
_providerConfig.assets.portal.primary900 Primary color - 900 [empty]
_providerConfig.assets.portal.secondary800 Secondary color - 800 [empty]
_providerConfig.assets.portal.secondary900 Secondary color - 900 [empty]
_providerConfig.assets.portal.css CSS override [empty]

If you are looking to generate custom css styles, use the following as a guideline. The UI currently only uses two generated styles from the colors:

    .text-primary-100 { color: ${colorValue}; }
    .bg-primary-100 { background-color: ${colorValue}; }

where ${colorValue} is whatever you decide as the value and the suffix can change as needed (i.e. primary-100 becomes primary-200 and so on).

Developers

Getting Started

First, setup:

yarn

Then, start a Keycloak server (use hosted Phase Two for easy testing), create a public OIDC client with http://localhost:3000 Root URL, and update the public/keycloak.json file with the client config.

Finally, run the development server:

yarn start

You mill most likely need to use the fully qualified portal url http://localhost:3000/auth/realms/master/portal.

Build the extension

mvn clean package

Put the jar in target/admin-portal-{version}.jar in the providers/ directory of your Keycloak distribution.

All documentation, source code and other files in this repository are Copyright 2023 Phase Two, Inc.