Downloading the UI

To customize the layout and functionality of the UI, you must download, rebuild, and deploy the UI project. The build process for UI uses the Webpack resource bundler to manage dependencies, optimize deliverables, and package the output.

ForgeRock provides the source code for the UI as a Maven project located in the am-external repository, accessible to ForgeRock BackStage accounts that are added to a subscription.

If you do not already have a ForgeRock BackStage account, get one from https://backstage.forgerock.com. For more information about adding your account to a subscription, see Getting access to product support in the ForgeRock Knowledge Base.

To Download the UI Source

Perform the following steps to get the source of the UI:

  1. Clone the am-external repository:

    $ git clone https://myBackStageID@stash.forgerock.org/scm/openam/am-external.git

    URL encode your BackStage ID if it contains special characters. For example : becomes %3A and @ becomes %40.

    Enter your BackStage password when prompted to do so.

  2. Check out the release/7.0.0 branch:

    $ cd am-external
    $ git checkout releases/7.0.0

    The UI project is located in the am-external/openam-ui/openam-ui-user/ folder.

  3. If you do not already have them, install the following prerequisites:

    Tip

    For information on building the UI as part of a Maven workflow for deployment inside a WAR file, see How do I customize the XUI using source code in AM (All versions) and OpenAM 12.x, 13.x? in the ForgeRock Knowledge Base.

  4. Use the yarn command to download the dependencies to the project:

    $ cd openam-ui/openam-ui-user
    $ yarn
    yarn install
    [1/4] 🔍 Resolving packages...
    [2/4] 🚚 Fetching packages...
    [3/4] 🔗 Linking dependencies...
    [4/4] 📃 Building fresh packages...
    ✨ Done in 9.08s.

    Tip

    In some environments you may receive an error such as gyp ERR! not ok when downloading dependencies.

    You can safely ignore such errors as they only apply to optional components in certain environments, or you could try the yarn install --ignore-optional command.

Read a different version of :