This document explains the installation steps for Grouper.


== Install Grouper API ==

1.  Download and copy the API to /tmp/ on grinnell.  The tarball is located at http://www.internet2.edu/grouper/release/2.1.4/grouper.api-2.1.4.tar.gz.

2.  Extract and build.

{{{
[root@grinnell ~]# mkdir /srv/grouper
[root@grinnell ~]# cd /srv/grouper/
[root@grinnell grouper]# cp /tmp/grouper.api-2.1.4.tar.gz .
[root@grinnell grouper]# gunzip grouper.api-2.1.4.tar.gz
[root@grinnell grouper]# tar xf grouper.api-2.1.4.tar
[root@grinnell grouper]# cd grouper.api-2.1.4
[root@grinnell grouper.api-2.1.4]# ant dist
Buildfile: build.xml

init:
    [mkdir] Created dir: /srv/grouper/grouper.api-2.1.4/dist/build/test
    [mkdir] Created dir: /srv/grouper/grouper.api-2.1.4/ext/conf

init.conf:

compile:
    [mkdir] Created dir: /srv/grouper/grouper.api-2.1.4/dist/build/grouper
    [javac] Compiling 869 source files to /srv/grouper/grouper.api-2.1.4/dist/build/grouper
    [javac] warning: [options] bootstrap class path not set in conjunction with -source 1.5
    [javac] Note: Some input files use unchecked or unsafe operations.
    [javac] Note: Recompile with -Xlint:unchecked for details.
    [javac] 1 warning
    [javac] Compiling 14 source files to /srv/grouper/grouper.api-2.1.4/dist/build/grouper
    [javac] warning: [options] bootstrap class path not set in conjunction with -source 1.5
    [javac] 1 warning
     [copy] Copying 941 files to /srv/grouper/grouper.api-2.1.4/dist/build/grouper

ext.init:
    [mkdir] Created dir: /srv/grouper/grouper.api-2.1.4/ext/bin
    [mkdir] Created dir: /srv/grouper/grouper.api-2.1.4/ext/doc

ext.compile:
   [subant] No sub-builds to iterate on

ext.init:

ext.install:
   [subant] No sub-builds to iterate on

test.compile:
    [javac] Compiling 401 source files to /srv/grouper/grouper.api-2.1.4/dist/build/test
    [javac] warning: [options] bootstrap class path not set in conjunction with -source 1.5
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/util/GrouperUtilTest.java:147: warning: unmappable character for encoding ASCII
    [javac]     String testString = "H13_FRA2007, Questions d?histoire de la lit?rature";
    [javac]                                                  ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/util/GrouperUtilTest.java:147: warning: unmappable character for encoding ASCII
    [javac]     String testString = "H13_FRA2007, Questions d?histoire de la lit?rature";
    [javac]                                                                     ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:423: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                        ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:423: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                         ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:423: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                             ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:423: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                              ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:423: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                                                    ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:423: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                                                     ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:423: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                                                         ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:423: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                                                          ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:424: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                              ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:424: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                               ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:424: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                   ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:424: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                    ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:424: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                                                 ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:424: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                                                  ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:424: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                                                      ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:424: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                                                       ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:455: warning: unmappable character for encoding ASCII
    [javac]       assertDoNotFindGroupByName( s, "t??st:??Group" );
    [javac]                                        ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:455: warning: unmappable character for encoding ASCII
    [javac]       assertDoNotFindGroupByName( s, "t??st:??Group" );
    [javac]                                         ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:455: warning: unmappable character for encoding ASCII
    [javac]       assertDoNotFindGroupByName( s, "t??st:??Group" );
    [javac]                                             ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:455: warning: unmappable character for encoding ASCII
    [javac]       assertDoNotFindGroupByName( s, "t??st:??Group" );
    [javac]                                              ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:466: warning: unmappable character for encoding ASCII
    [javac]       gA  = assertFindGroupByName( s, "t??st:??Group" );
    [javac]                                         ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:466: warning: unmappable character for encoding ASCII
    [javac]       gA  = assertFindGroupByName( s, "t??st:??Group" );
    [javac]                                          ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:466: warning: unmappable character for encoding ASCII
    [javac]       gA  = assertFindGroupByName( s, "t??st:??Group" );
    [javac]                                              ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/TestXml.java:466: warning: unmappable character for encoding ASCII
    [javac]       gA  = assertFindGroupByName( s, "t??st:??Group" );
    [javac]                                               ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:418: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                        ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:418: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                         ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:418: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                             ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:418: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                              ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:418: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                                                    ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:418: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                                                     ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:418: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                                                         ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:418: warning: unmappable character for encoding ASCII
    [javac]       Group gA = new GroupSave(grouperSession).assignGroupNameToEdit("t??st:??Group").assignName("t??st:??Group")
    [javac]                                                                                                          ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:419: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                              ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:419: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                               ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:419: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                   ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:419: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                    ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:419: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                                                 ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:419: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                                                  ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:419: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                                                      ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:419: warning: unmappable character for encoding ASCII
    [javac]         .assignDisplayName("t??st:??Group").assignDescription("t??st:??Group").assignCreateParentStemsIfNotExist(true).save();
    [javac]                                                                       ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:453: warning: unmappable character for encoding ASCII
    [javac]       assertDoNotFindGroupByName( s, "t??st:??Group" );
    [javac]                                        ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:453: warning: unmappable character for encoding ASCII
    [javac]       assertDoNotFindGroupByName( s, "t??st:??Group" );
    [javac]                                         ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:453: warning: unmappable character for encoding ASCII
    [javac]       assertDoNotFindGroupByName( s, "t??st:??Group" );
    [javac]                                             ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:453: warning: unmappable character for encoding ASCII
    [javac]       assertDoNotFindGroupByName( s, "t??st:??Group" );
    [javac]                                              ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:467: warning: unmappable character for encoding ASCII
    [javac]       gA  = assertFindGroupByName( s, "t??st:??Group" );
    [javac]                                         ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:467: warning: unmappable character for encoding ASCII
    [javac]       gA  = assertFindGroupByName( s, "t??st:??Group" );
    [javac]                                          ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:467: warning: unmappable character for encoding ASCII
    [javac]       gA  = assertFindGroupByName( s, "t??st:??Group" );
    [javac]                                              ^
    [javac] /srv/grouper/grouper.api-2.1.4/src/test/edu/internet2/middleware/grouper/xml/importXml/XmlLegacyTest.java:467: warning: unmappable character for encoding ASCII
    [javac]       gA  = assertFindGroupByName( s, "t??st:??Group" );
    [javac]                                               ^
    [javac] Note: Some input files use or override a deprecated API.
    [javac] Note: Recompile with -Xlint:deprecation for details.
    [javac] Note: Some input files use unchecked or unsafe operations.
    [javac] Note: Recompile with -Xlint:unchecked for details.
    [javac] 51 warnings
     [copy] Copying 7 files to /srv/grouper/grouper.api-2.1.4/dist/build/test

dist:
    [mkdir] Created dir: /srv/grouper/grouper.api-2.1.4/dist/lib
     [copy] Copying 1 file to /srv/grouper/grouper.api-2.1.4/dist/build/grouper
     [copy] Copying 1 file to /srv/grouper/grouper.api-2.1.4/dist/build/grouper
     [copy] Copying 1 file to /srv/grouper/grouper.api-2.1.4/dist/build/grouper
     [copy] Copying 1 file to /srv/grouper/grouper.api-2.1.4/dist/build/grouper
      [jar] Building jar: /srv/grouper/grouper.api-2.1.4/dist/lib/grouper-20130602.jar
     [copy] Copying 1 file to /srv/grouper/grouper.api-2.1.4/dist/lib
    [mkdir] Created dir: /srv/grouper/grouper.api-2.1.4/dist/lib/test
      [jar] Building jar: /srv/grouper/grouper.api-2.1.4/dist/lib/test/grouper-test.jar

BUILD SUCCESSFUL
Total time: 40 seconds
}}}


== Basic Grouper Configuration ==

1.  Find the following properties in /srv/grouper/grouper.api-2.1.4/conf/grouper.properties and update the values.

{{{
groups.create.grant.all.read = false
groups.create.grant.all.view = false
groups.wheel.use = true
grouperIncludeExclude.use = true
}}}

The first two properties will prevent everybody from having read and view access to newly created groups by default.  The third property will allow the use of a wheel group.  Members of the wheel group have full access in Grouper.  The name of this wheel group is etc:sysadmingroup.  And the forth property allows the use of include/exclude groups.

2.  Configure database settings.  Find the following properties in /srv/grouper/grouper.api-2.1.4/conf/grouper.hibernate.properties and update the values.

{{{
hibernate.connection.url = jdbc:oracle:thin:@msct.alaska.edu:1536:MSCT
hibernate.connection.username = grouper
hibernate.connection.password = <password>
}}}

3.  Configure subject source settings in /srv/grouper/grouper.api-2.1.4/conf/sources.xml.

   a) Delete the entire source element with <id>jdbc</id>.
   b) Add source element for LDAP.