diff --git a/README.md b/README.md index 643f177..4e201b3 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,34 @@ -# Grouper Training Environment (gte) -The gte is a set of docker images that contain all the software components, configuration, and setup necessary to complete the InCommon Grouper Training course. Each docker image tag coincides with a particular course, exercise, step, and the overall gte version. For example, the gte image tag for 101 Grouper Basics is 101.1.1-201906. The docker command to run the image for the 101 course is: -``` +# Grouper Training Environment + +The Grouper Training Environment (gte) is a set of docker images that contain +all the software components, configuration, and setup necessary to complete the +InCommon Grouper Training course. Each docker image tag coincides with a +particular course, exercise, step, and the overall gte version. For example, +the gte image tag for Grouper Basics 101 is 101.1.1-201906. The docker command +to run the image for the 101 course is: + +``` bash + docker run -d -p 80:80 -p 389:389 -p 8443:443 -p 3306:3306 \ - --name gte-101.1.1 tier/gte:101.1.1-201906 + --name 101.1.1 tier/gte:101.1.1-201906 + ``` + This will start Grouper, a Shibboleth IdP, OpenLDAP, mySQL, and other components. It will take a little while for the container to be ready. You can watch the logs as the various components are coming up with this command: + +``` bash +docker logs -f 101.1.1 ``` -docker logs -f gte-101.1.1 -``` + Once the container is ready, browse to to access the Grouper UI and log in with one of the following: + - Grouper Administrator - username: `banderson`, password: `password` - Normal User - username: `jsmith`, password: `password` The container has a few other applications running. phpMyAdmin provides an admin interface to the Grouper mySQL database. phpLDAPadmin provides an admin interface to OpenLDAP. Finally, there is a sample application that displays subject attributes for the user that is logged in. + - phpMyAdmin - username: `root`, password: (blank) - phpLDAPadmin @@ -22,30 +36,37 @@ The container has a few other applications running. phpMyAdmin provides an admin - Shibboleth SP subject attributes All of the gte image tags are published to . To use a particular image tag, run: -``` + +``` bash docker run -d -p 80:80 -p 389:389 -p 8443:443 -p 3306:3306 \ - --name {VERSION_TAG} tier/gte:{VERSION_TAG} + --name {coures}.{exercise}.{step} tier/gte:{VERSION_TAG} ``` + Where {VERSION_TAG} takes the form of {course}.{exercise}.{step}-{version}. For example: -``` + +``` bash docker run -d -p 80:80 -p 389:389 -p 8443:443 -p 3306:3306 \ - --name 101.1.1-201906 tier/gte:101.1.1-201906 + --name 101.1.1 tier/gte:101.1.1-201906 ``` More information about Grouper Training can be found on the Internet2 wiki: . -# Rabbit MQ for 401 exercises -The 401 exercises require Rabbit MQ. Before starting the 401 docker images, start Rabbit MQ: -``` +## Rabbit MQ for 401 exercises + +The 401 exercises require Rabbit MQ. Before starting the 401 docker images, +start Rabbit MQ and a queue named `grouper`. + +``` bash docker run -d -p 15672:15672 --env RABBITMQ_NODENAME=docker-rabbit \ --hostname rabbitmq --name=rabbitmq rabbitmq:management ``` Then browse to and login with `guest`/`guest`, and create a new queue named `grouper`. -Finally, start the 401 Grouper with this slightly modified command: -``` +Finally, start the 401 series gte with this slightly modified command: + +``` bash docker run -d -p 389:389 -p 8443:443 -p 3306:3306 \ - --link rabbitmq:rabbitmq --name tier/gte:401.{X.X|end}-201906 + --link rabbitmq:rabbitmq --name {coures}.{exercise}.{step} tier/gte:{VERSION_TAG} ```