Uploaded image for project: 'Red Hat build of Keycloak'
  1. Red Hat build of Keycloak
  2. RHBK-2328

Clicking on link to Keycloak documentation from Keycloak admin UI does nothing instead of opening documentation [GHI#34519]

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False

      Before reporting an issue

      [X] I have read and understood the above terms for submitting issues, and I understand that my issue may be closed without action if I do not follow them.

      Area

      admin/ui

      Describe the bug

      Clicking on the button in the Keycloak admin UI opens up a pop-up menu with a button labeled "Documentation". Clicking this link in Keycloak versions prior to v25 will bring you to https://www.keycloak.org/docs/latest/server_admin/index.html. Clicking this link in version 25+, including the latest v26.0.4 does nothing - does not open the link in a new tab or otherwise.

      !keycloak_26_link_broken

      Tested using the Keycloak docker container:

      • docker run -p 8080:8080 -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin quay.io/keycloak/keycloak:26.0.4 start-dev - clicking the link does nothing.
      • docker run -p 8080:8080 -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin quay.io/keycloak/keycloak:25.0 start-dev - clicking the link does nothing
      • docker run -p 8080:8080 -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin quay.io/keycloak/keycloak:24.0 start-dev - clicking the link opens the Keycloak documentation in a new tab.

      Browsers I've seen the issue on:

      • Firefox 131.0.3 (Windows),
      • Edge 130.0.2849.56 (Windows),
      • Firefox 128.3.0esr (Rocky Linux).

      Version

      26.0.4

      Regression

      [X] The issue is a regression

      Expected behavior

      Clicking on the Documentation link in the admin UI should open https://www.keycloak.org/docs/latest/server_admin/index.html in the user's browser.

      Actual behavior

      Clicking on the Documentation link does nothing, no errors logged in the console, no network requests made.

      How to Reproduce?

      (1) Boot up Keycloak v26.0.4 (e.g. via Docker docker run -p 8080:8080 -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin quay.io/keycloak/keycloak:26.0.4 start-dev)
      (2) Log into the admin UI (e.g. http://localhost:8080/admin/master/console/)
      (3) Click on the button next to the user account dropdown in the top right of the console.
      (4) Click on the Documentation button that appears.

      Anything else?

      If it's helpful, this is the HTML for the element that holds the Documentation link.

      In Keycloak v24, where the link functions:
      ```
      <li role="none" id="link">
      <a tabindex="-1" data-ouia-component-type="PF4/DropdownItem" data-ouia-safe="true" data-ouia-component-id="OUIA-Generated-DropdownItem-1" target="blank" aria-disabled="false" href="https://www.keycloak.org/docs/latest/server_admin/index.html" class="pf-c-dropdown_menu-item" role="menuitem">

        <div class="pf-l-split">
           <div class="pf-l-split__item pf-m-fill">Documentation</div>
           <div class="pf-l-split__item">
              <svg style="vertical-align: -0.125em;" fill="currentColor" height="1em" width="1em" viewBox="0 0 512 512" aria-hidden="true" role="img">
                 <path d="M432,320H400a16,16,0,0,0-16,16V448H64V128H208a16,16,0,0,0,16-16V80a16,16,0,0,0-16-16H48A48,48,0,0,0,0,112V464a48,48,0,0,0,48,48H400a48,48,0,0,0,48-48V336A16,16,0,0,0,432,320ZM488,0h-128c-21.37,0-32.05,25.91-17,41l35.73,35.73L135,320.37a24,24,0,0,0,0,34L157.67,377a24,24,0,0,0,34,0L435.28,133.32,471,169c15,15,41,4.5,41-17V24A24,24,0,0,0,488,0Z"></path>
              </svg>
           </div>
        </div>
      

      </a>
      </li>
      ```
      In Keycloak v26.0.4, where it does not:
      ```
      <li class="pf-v5-c-menu__list-item" role="none" data-ouia-component-type="PF5/DropdownItem" data-ouia-safe="true" data-ouia-component-id="OUIA-Generated-DropdownItem-1" href="https://www.keycloak.org/docs/latest/server_admin/index.html">
      <button id="link" tabindex="0" class="pf-v5-c-menu__item" role="menuitem" type="button">

        <span class="pf-v5-c-menu__item-main">
           <span class="pf-v5-c-menu__item-text">
              <div class="pf-v5-l-split">
                 <div class="pf-v5-l-split__item pf-m-fill">Documentation</div>
                 <div class="pf-v5-l-split__item">
                    <svg class="pf-v5-svg" viewBox="0 0 512 512" fill="currentColor" aria-hidden="true" role="img" width="1em" height="1em">
                       <path d="M432,320H400a16,16,0,0,0-16,16V448H64V128H208a16,16,0,0,0,16-16V80a16,16,0,0,0-16-16H48A48,48,0,0,0,0,112V464a48,48,0,0,0,48,48H400a48,48,0,0,0,48-48V336A16,16,0,0,0,432,320ZM488,0h-128c-21.37,0-32.05,25.91-17,41l35.73,35.73L135,320.37a24,24,0,0,0,0,34L157.67,377a24,24,0,0,0,34,0L435.28,133.32,471,169c15,15,41,4.5,41-17V24A24,24,0,0,0,488,0Z"></path>
                    </svg>
                 </div>
              </div>
           </span>
        </span>
      

      </button>
      ```

              Unassigned Unassigned
              pvlha Pavel Vlha
              Keycloak UI
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: