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 Docker

This repository contains Dockerfiles, documenation, and other files necessary to
build and deploy Dockerized versions of
[COmanage Registry](https://spaces.internet2.edu/display/COmanage/Home),
[COmanage Match](https://spaces.at.internet2.edu/display/COmanage/Home),
and other tools commonly deployed with Registry and Match.

Since both COmanage Registry and COmanage Match are web applications that require 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 Products

If you are new to COmanage follow these instructions to build
and run a simple deployment suitable for evaluation (but not suitable for production): 

* [COmanage Registry](https://github.com/Internet2/comanage-registry-docker/blob/master/docs/evaluation.md)
* [COmanage Match](comanage-match/docs/evaluation.md)


## Building and Deploying Images and Running Services

The following link to detailed instructions for building 
and deploying individual images and running services for
production:

* [COmanage Registry](https://github.com/Internet2/comanage-registry-docker)
* [COmanage Match](comanage-match/README.md)