Chapter 8. XUI Configuration Parameters

The configuration of the XUI is based on settings in the themeConfig.json file. When OpenAM is installed, this file can be found in the /path/to/webapps/XUI directory.

Interface Stability: Internal

XUI is not supported for production use.

The following table depicts the parameters found in this file. All color codes are standard CSS Hex colors. If there is more than one theme, they may inherit parameters from the default theme.

  • themes: Title; also represents an array of theme objects.

    • name: Theme title.

    • path: Relative path to CSS files.

    • realms: For a realm named test, enter ["test.*"].

    • regex: true or false.

    • icon: Filename of icon.

    • settings: Includes logo, lessVars, footer.

      • logo: Parameters for the logo, including src,title, alt, height, width.

        • src: Filename with logo.

        • title: Title attribute, shown behind the graphic.

        • alt: Text that appears upon cursor hover.

        • height: Logo height.

        • width: Logo width.

      • lessVars: Settings for variables used in LESS CSS stylesheets.

        • background-color: Standard background color; use hex or standard color words.

        • background-image: URL or relative path to file image

        • background-repeat: If set to repeat, fills screen with multiple copies of the image.

        • background-position: Position of the background image, in a format such as left top or right bottom.

        • footer-background-color: Background color of the footer area; hex or standard color words accepted.

        • column-padding: Distance between columns.

        • login-container-width: Width of view box with login text boxes

        • login-container-label-align: Alignment of labels in the login container, such as left, right, or center.

        • message-background-color: Login message background color.

        • content-background: Login container background color.

        • font-color: Login container font color.

        • font-size: Despite the name, this is the distance between login labels and text boxes

        • font-family: Available fonts.

        • site-width: Total width available for the login screen.

        • line-height: Height of text lines.

        • color-active: Border color of active text box and menu option.

        • color-inactive: Border color of inactive text box.

        • active-menu-color: Color of active menu option.

        • active-menu-font-color: Color of the font used in the active menu option.

        • inactive-menu-color: Color of inactive menu options.

        • inactive-menu-font-color: Color of font used in the inactive menu options.

        • active-menu-color: Color of active menu option.

        • button-hover-lightness: Reduction in color, in percent.

        • href-color: Color of text links.

        • href-color-hover: Color of text links of the optiom currently being hovered over by the pointer

        • color-error: Color of error text.

        • color-warning: Color of warning text.

        • color-success: Color of text of a success message.

        • color-info: Color of information message.

        • color-inactive: Text color of inactive messages.

        • input-border-basic: Border color of active input text box.

        • header-border-color: Border color of the header.

        • footer-height: Height of the footer.

      • footer: Parameters in the footer, typically mailto and phone.

        • mailto: Email address.

        • phone: Telephone number.