The Grouper Book is being "written" in sections off-line and being added to the Wiki in draft form. It aims to provide documentation on Grouper which can take people from beginner to expert. It supplements and summarises existing documentation, simplifying and provide background where appropriate. 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

• Introduction - draft

• 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

• Part 2 - Grouper core
  • Case studies - blank
    • Cardiff University - draft
  • Getting started with the quickstart- draft
    • Installing the quickstart - Linux- draft
      • Installing a JDK - draft
      • Installing the RPM version of the JDK - draft
      • Installing the self-extracting version of the JDK - draft
      • Installing Tomcat - draft
      • Installing Apache Ant - draft
      • Setting up the quick start - draft
      • Starting the quickstart - draft
    • Installing the quickstart - Windows- draft
      • Installing a JDK - draft
      • Installing Tomcat - draft
      • Installing Apache Ant - draft
      • Setting up the quick start - draft
      • Starting the quick start - draft
  • Exploring Grouper - draft
    • Find a folder or a group by navigation - draft
    • Find an entity or a group by searching - draft
    • Read a group's membership list - draft
    • Add a member (entity or group) to a group - draft
    • Remove a member from a group - draft
    • Assign someone to be able to manage a group - draft
    • Create a new group - draft
    • Create a composite group - draft
    • Create a new folder - draft
    • Assign someone to be able to create new folders or groups within a parent folder -draft
    • Accessing the "Lite" UI directly -draft
  • Moving to production - draft
    • Key questions to consider - draft
    • Installation of core components -blank
    • Development with a configure-deploy-test-review cycle - draft
    • Setting up the repository database - draft
    • Connecting to a subject source - draft
    • Installing an application server and the Grouper UI - draft
    • Detailed planning prior to live deployment - link to existing page
    • 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

• Part 3 - Getting more from Grouper
  • Web service - blank
    • CXF web service client - draft
  • Accessing data and provisioning from Grouper
    • LDAPPC-NG - draft
  • Provisioning to Grouper - blank
  • Other services - blank
  • Integrating Grouper - blank
  • Community contributions - blank

• Part 4 - Deep dive into Grouper
  • Inside Grouper - blank
  • High availability - blank
  • Developing for Grouper - blank