Child pages
  • UI Building and Configuration
Skip to end of metadata
Go to start of metadata

This page is old and is not being updated. Please see this page.

Configuring and Deploying the Grouper UI

This document pertains to Grouper v1.2.1 and later.

In this section we describe how to configure, build, and deploy the Grouper UI.

UI Configuration

For many purposes, UI customization needs can be met by altering declarations in the grouper-ui/resources/grouper/media.properties file. Logos, use of subject attributes in various search and display contexts, sorting behavior, and much more is specified in this file. See Grouper UI Properties for the details.

The UI is designed to be deeply customizable while remaining "upgrade proof".  Details are found at Customising the Grouper UI.

Building & Deploying

  1. Copy grouper-ui/build.properties.template to grouper-ui/build.properties.
     
  2. Review grouper-ui/build.properties.
     
    • If you want the build script to automatically install the UI in your Tomcat instance, uncomment and set the appropriate value for deploy.home. If you do not set this you will need to copy the UI to your Tomcat installation's webapps directory. You will probably want to define the default.webapp.folder to suit how you intend to develop or customise the UI. See the Grouper UI Development Environment for options.
    • Make sure you set the grouper.folder property to the location of your Grouper installation.
       
  3. Copy grouper-ui/template-tomcat-context.xml to grouper-ui/tomcat-context.xml (or the value of the property deploy.context.xml if you have changed this).
    • Tomcat specific configuration can be added in this file e.g., container managed data sources.
       
  4. Change directory to grouper-ui and type "ant".
    • A list of build targets is displayed. If you have set deploy.home enter "default". Otherwise type "dist" or "war". If the former copy <dist.home>/grouper to <TOMCAT_HOME>/webapps, or if the latter, copy <dist.home>/grouper.war to <TOMCAT_HOME>/webapps.
    • If you want to take advantage of the 'nice' targets you must uncomment and set appropriate values for all the deploy properties in grouper-ui/build.properties.
       
      Note: The build process will attempt to create a directory peer to the grouper-ui directory. Hence, the directory grouper-ui/.. must be writable.
  • No labels