This is an old wiki page, no longer maintained

Welcome to the Grouper v1.5.0 Product Documentation Space

Software Overview

Download - Download the latest product version from the main Grouper Software web site.
Specsheet - Offers operational specifications for the development and deployment of Grouper.
License - Terms under which Grouper is licensed, the Apache 2.0 license.
Archives - Details feature information and downloads of previous Grouper versions.
Glossary - Terms and definitions relevant to Grouper.

Grouper Trademark Guidelines and Styleguide - Usage policy for the Grouper logo.

Grouper Integration

Graphic illustration of the the range of options for integrating Grouper with existing Identity Management components and with applications.

Systems Administration

Installation & Configuration

Prerequisites - Establish the Grouper environment.
API Installation - Configure the API and integrate with existing identity stores.
UI Installation - Configure, build, and deploy Grouper's User Interfaces.
WS Installation - Build, secure, and deploy Grouper Web Services.
Initializing Administration of Privileges - The first stem and group you should create.

Tools & Topics for On-Going Administration

GrouperShell - Documentation for the gsh command line utility.
LDAPPC - Documentation for the LDAP Provisioning Connector.
Grouper Client - Experimental client for Grouper LDAP and Web Services.
Import/Export Tool - Documentation for the XML Import/Export tool.
Unresolvable Subject Deletion Utility - Documentation for the command line usdu tool.
Bad Membership Finder Utility - Documentation for the findbadmemberships command line script.
Custom Group Types & Fields - What they are and how to create and delete them.
User Audit Log - How to review who made what changes and when.
Notification - Grouper can incrementally provision external systems
Move and Copy - How to move / copy groups or stems.
Grouper Daemon - Documentation for background processing including: GrouperLoader, notifications and membership expiry.
Grouper UIs - Information on web-based user interfaces provided with Grouper.
Attribute framework - Grouper v1.5.0 has a new attribute framework for assigning metadata to grouper objects
Role and permission management - Grouper v1.5.0 allows external applications to central management roles and permissions in Grouper
Enabled and disabled dates - Memberships can be set to apply only in the future, or for a certain period of time
Shibboleth Integration - Grouper as a Data Connector Extension for Shibboleth.

Applications Development

Grouper UI Customisation Guide

Developer's Guide to Grouper Web Services

Hooks for 3rd party extensions to the java API

API & UI v1.5.0 Javadoc
WS v1.5.0 Javadoc
Grouper Client v1.5.0 Javadoc

Grouper source code is in Internet2's SVN repository. We recommend getting the 1.5 branch, which will always include the latest patches to the 1.5 release.  Viewvc.  For command line users:

svn co

Bug Reports - Bugs submitted and fixes found here. Note: You will need to create a login with Jira.

Archived Documentation

    (warning) Archived documentation can be viewed on the Archives page, bundled in a (.PDF) file under each release version (major- and sub-releases only.)

Community Area

    Documents & Presentations - View others' and post your Grouper-related drafts and final works.

    Contributions - Share your code, software, documentations, use cases, and other contributions with the Grouper community.