README.md

# shib-ui
Code and files for the TIER Shibboleth UI Project

This repository contains both:
* the needed artifacts to build (including auto-builds through Jenkins) a Docker image of the Shibboleth UI, 
* and a "testbed" that provides the full environment one needs to explore and gain experience with the Shibboleth UI.

The Docker image of the Shibboleth UI follows the TIER Docker packaging standards, utilizing CentOS7, the Zulu JDK, supervisord, and the TIER Beacon configuration.

## How To

* Install Docker. These instructions require version 17.03.1 or higher.

* TIER can build an image for Shib UI with something like the following:
```
docker build --rm -t tier/shib-idp-ui
```

* And then that image could be run with something like the following:
```
docker run -p 8080:8080 tier/shib-idp-ui
```

### Testbed environment

* There is a "testbed" environment that you can build and run that is embedded into this repository. That testbed includes the:
* Shibboleth UI, 
* a Shibboleth IdP 
    * with a shared filesystem between the Shibboleth UI and Shibboleth IdP, 
* an LDAP server as the base credential/attribute store for the IdP, 
* and the TIER Maria DB image for the UI's persistent database.

To setup that testbed, you need to:

* Clone this repository:
```
git clone https://github.com/Internet2/shib-ui.git
```
* __cd__ into _test-compose/_
* Run the following command:
```
docker-compose kill; docker-compose rm; docker-compose build && docker-compose up
```