Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setting up Keycloak che-username-readonly-theme #1723

Merged
merged 9 commits into from
Dec 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions modules/installation-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
** xref:configuring-storage-types.adoc[]
** xref:importing-untrusted-tls-certificates.adoc[]
** xref:switching-between-external-and-internal-communication.adoc[]
** xref:setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page.adoc[]

* xref:upgrading-che.adoc[]

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[id="setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page"]
// = Setting up the Keycloak che-username-readonly theme for the Eclipse Che login page
:navtitle: Setting up the Keycloak che-username-readonly theme for the Eclipse Che login page
:keywords: installation-guide, setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page, keycloak
:page-aliases: .:setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page

include::partial$proc_setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,7 @@ The next sections describe some specific user stories.

* xref:switching-between-external-and-internal-communication.adoc[]

* xref:setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page.adoc[]


:context: {parent-context-of-configuring-che}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Module included in the following assemblies:
//
// configuring-che

[id="setting-up-the-{identity-provider-id}-{prod-id-short}-username-readonly-theme-for-the-{prod-id}-login-page_{context}"]
= Setting up the {identity-provider} {prod-id-short}-username-readonly theme for the {prod} login page

The following procedure is relevant for all {prod-short} instances with the OpenShift OAuth service enabled.

When a user with pre-created namespaces logs in to {prod} Dashboard for the first time, a page allowing the user to update account information is displayed. It is possible to change the username, but choosing a username that doesn't match the OpenShift username, prevents the user's workspaces from running. This is caused by {prod-short} attempts to use a non-existing namespace, the name of which is derived from a user OpenShift username, to create a workspace. To prevent this, modify the {identity-provider} settings using the steps below.


.Prerequisites

* An instance of {prod-short} running in OpenShift.
* A user is logged in to the {identity-provider} service.

.Procedure

After changing a username, set the *Login Theme* option to `readonly`.

. In the main *Configure* menu on the left, select *Realm Settings*:
+
image::keycloak/{project-context}-keycloak-username-readonly-theme.png[link="../_images/keycloak/{project-context}-keycloak-username-readonly-theme.png"]

. Navigate to the *Themes* tab.

. In the *Login Theme* field, select the `{prod-id-short}-username-readonly` option and click the btn:[Save] button to apply the changes.