README.md

<!--
COmanage Docker documentation

Portions licensed to the University Corporation for Advanced Internet
Development, Inc. ("UCAID") under one or more contributor license agreements.
See the NOTICE file distributed with this work for additional information
regarding copyright ownership.

UCAID licenses this file to you under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with the
License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# COmanage Match Docker

These instructions detail how to 
build and deploy a Dockerized version of
[COmanage Match](https://spaces.internet2.edu/display/COmanage/Home), as well as
other infrastructure commonly deployed with COmanage Match.

Since COmanage Match is a web application that requires a relational database
and an authentication mechanism such as 
[Shibboleth](https://www.shibboleth.net/products/service-provider/), 
[mod\_auth\_openidc](https://github.com/zmartzone/mod_auth_openidc),
or just simple [Basic Authentication](https://httpd.apache.org/docs/2.4/mod/mod_auth_basic.html),
this repository includes multiple Dockerfiles to build images that use various
combinations of tools.

## Evaluate COmanage Match

If you are new to COmanage Match follow [these instructions](docs/evaluation.md) to build
and run a simple deployment suitable for evaluating COmanage Match. 

## Building Images

The following link to detailed instructions for building each individual image. See the next
section for links to documentation on how to deploy the images as services.

* [COmanage Match base image](comanage-match-base/README.md)
* [COmanage Match with Basic Authentication](comanage-match-basic-auth/README.md)
* [COmanage Shibboleth SP base image](../comanage-shibboleth-sp-base/README.md)
* [COmanage Match with Shibboleth SP](comanage-match-shibboleth-sp/README.md)
* [COmanage Match for Internet2 TAP base](comanage-match-internet2-tap-base/README.md)
* [COmanage Match for Internet2 TAP](comanage-match-internet2-tap/README.md)
* [PostgreSQL for COmanage Match](comanage-match-postgres/README.md)

## Deploying Images and Running Services

Since COmanage Match requires a relational database
it is commont that multiple images need to be simultanesouly instantiated
as containers. Orchestrating multiple containers to create services is easiest using
tools such as [Docker Compose](https://docs.docker.com/compose/), 
[Docker Swarm](https://docs.docker.com/engine/swarm/), or 
[Kubernetes](https://kubernetes.io/).

The images built from Dockerfiles in this repository may be used with any container
orchestration platform but the documentation demonstrates how to deploy with
Docker Swarm (the simple evaluation scenario above uses Docker Compose).

The following link to detailed instructions for a number of deployment scenarios.

* [COmanage Match using the Internet2 TAP image and PostgreSQL database](docs/internet2-postgresql.md)
* [COmanage Match using the Shibboleth SP and PostgreSQL database](docs/shibboleth-sp-postgresql.md)

## All Documentation

### Building Images

* [COmanage Match base image](comanage-match-base/README.md)
* [COmanage Match with Basic Authentication](comanage-match-basic-auth/README.md)
* [COmanage Shibboleth SP base image](../comanage-shibboleth-sp-base/README.md)
* [COmanage Match with Shibboleth SP](comanage-match-shibboleth-sp/README.md)
* [COmanage Match for Internet2 TAP base](comanage-match-internet2-tap-base/README.md)
* [COmanage Match for Internet2 TAP](comanage-match-internet2-tap/README.md)
* [PostgreSQL for COmanage Match](comanage-match-postgres/README.md)

### Deploying Services

* [COmanage Match using the Internet2 TAP image and PostgreSQL database](docs/internet2-postgresql.md)
* [COmanage Match using the Shibboleth SP and PostgreSQL database](docs/shibboleth-sp-postgresql.md)

### Other

* [COmanage Match Volumes and Data Persistence](docs/volumes-and-data-persistence.md)
* [Evaluating COmanage Match using Docker](docs/evaluation.md)
* [Environment Variables Common to All Images](docs/comanage-match-common-environment-variables.md)
* [Environment Variables Common to Images using Shibboleth SP for Authentication](../docs/comanage-common-shibboleth-environment-variables.md)