Child pages
  • Grouper UI Installation
Skip to end of metadata
Go to start of metadata

Grouper new UI

 These topics are discussed in the "Grouper API" training series.

Configuring and Deploying Grouper UIs

This page pertains to Grouper v1.5 and later. In v2.4, the Admin UI and Lite UI have been removed from the default distribution. They can be added back from a custom patch if needed.

This section describes how to configure, build, and deploy the Grouper UI, including the new Grouper 2.2 UI, the Admin (legacy) UI, and the LITE UIs.

Note: Grouper 2.2 features a new, more user-friendly UI. It is installed as the default UI (default URL).

UI Configuration

For many purposes, UI customization needs can be met by altering declarations in the grouper-ui/conf/grouper-ui.properties file (the possible configurations are listed and documented in the grouper-ui.base.properties). Logos, use of subject attributes in various search and display contexts, sorting behavior, and much more is specified in this file. See Grouper UI configuration for the details.

The UI is designed to be deeply customizable while remaining "upgrade proof". For versions prior to Grouper 2.2, see Customising the Grouper UI.  For Grouper 2.2 and above, refer to the configuration file grouper-ui.base.properties, and the overrides in grouper-ui.properties.

Building & Deploying

Note, you can run the Grouper installer to see an example of setting up the grouper UI.

  1. Copy grouper-ui/build.properties.template to grouper-ui/build.properties.
  2. Review grouper-ui/build.properties.
    • Set login.ui-lite.show-link=true if you want users to be able to log in to the Lite UI and set ui-lite.link-from-admin-ui=true if you want the Administrative UI to use the Lite UI's membership management widget.
    • 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. Edit the tomcat conf server.xml

    <Context docBase="C:\temp\installer2\grouper.ui-2.2.1\dist\grouper" path="/grouper" reloadable="false"/>

    Note that with the most recent releases of Tomcat, including recent releases in the 6.x, 7.x, 8.x, and 9.x series, you may need to use the following <Context> element to work around persistent CSRF errors:

    <Context docBase="C:\temp\installer2\grouper.ui-2.2.1\dist\grouper" path="/grouper" reloadable="false" mapperContextRootRedirectEnabled="true" mapperDirectoryRedirectEnabled="true"/>
  4. Note, you can do the #3 bullet, or just make a war and put that in your servlet container (e.g. tomcat webapps dir)
  5. Change directory to grouper-ui and type "ant".
    •  Edit the tomcat server.xml <Connectors to have uri encoding of utf8
      <Connector  URIEncoding="UTF-8"
    • 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.
  6. Set memory limit for tomcat

     

    Editing file: C:\temp\installer2\apache-tomcat-6.0.35\bin\catalina.bat
    Adding max memory to file at line number: 65
    - old permgen memory value is same as new value: 256M
    Editing file: C:\temp\installer2\apache-tomcat-6.0.35\bin\catalina.sh
    Adding max memory to file at line number: 65
    - old permgen memory value is same as new value: 256M

     

     
  7. Set URIEncoding to UTF-8 in tomcat server.xml <Connector> elements encoding
     

    - adding tomcat URIEncoding attribute for element <Connector AJP with value: 'UTF-8'
    - adding tomcat URIEncoding attribute for element <Connector HTTP with value: 'UTF-8'
  8. Edit the log dir in log4j.properties
     

    Editing file: C:\temp\installer2\grouper.ui-2.2.1\dist\grouper\WEB-INF\classes\log4j.properties
    - changing UI log directory from: 'C:/temp/installer2/grouper.apiBinary-2.2.1/logs' to: 'C:/temp/installer2/apache-tomcat-6.0.35/logs/grouperUi'
  9. Edit tomcat-users.xml

    <role rolename="grouper_user"/>
    <user username="GrouperSystem" password="XXXXXXX" roles="grouper_user"/>

 



 

 

Note: The build process will attempt to create a directory peer to the grouper-ui directory. Hence, the directory grouper-ui/.. must be writable.

See Also

How to Customize the Grouper UI

Grouper UI Properties

Grouper LITE UIs

Grouper new UI

  • No labels