If you are looking at setting up an instance of Grouper we recommend starting with the Grouper Deployment Guide. The rest of the information below is supplemental information that may help along the way.
The Grouper Book was started in 2011 by a community member, but not completed. It aimed to provide documentation on Grouper which could take people from beginner to expert. It was to supplement and summarize existing documentation which is actively updated. Contributions and comments from the Grouper community are welcome.
Sections on the Wiki will be marked in one of 4 stages:
- Blank - no real content yet
- Draft - initial drafts
- Reviewed - has been reviewed for accuracy (technical and linguistic)
- Completed - finished (at least for the current version)
Table of Contents
- Part 1 - Introductory Information - draft
- What is Grouper and what can it do? - draft
- SQL database
- Grouper API
- Web Interface
- Provisioning
- How could Grouper be useful to me? Typical use-cases - blank
- What is Internet2 and where does Grouper fit into it? - blank
- What is Grouper and what can it do? - draft
- Part 2 - Grouper core
- Exploring Grouper
- Find a folder or a group by navigation
- Find an entity or a group by searching
- Read a group's membership list
- Add a member (entity or group) to a group
- Remove a member from a group - draft
- Assign someone to be able to manage a group - draft
- Create a new group
- Create a composite group - draft
- Create a new folder
- Assign someone to be able to create new folders or groups within a parent folder -draft
- Moving to production - draft
- Key questions to consider - draft
- Installation of core components
- Development with a configure-deploy-test-review cycle - draft
- Connecting to a subject source - draft
- Installing an application server and the Grouper UI - draft
- Detailed planning prior to live deployment
- Deployment and testing in live - draft
- Running in production - Grouper loader - draft
- Monitoring - draft
- Management using GSH - link to existing page
- Management using the API - draft
- Upgrading Grouper - draft
- Exploring Grouper
- Part 3 - Getting more from Grouper
- Web service - draft
- Accessing data and provisioning from Grouper
- Other services - blank
- Integrating Grouper - blank
- Community Contributions
- Part 4 - Deep dive into Grouper
- Inside Grouper - blank
- High availability - blank
- Developing for Grouper - blank