Skip to content
Permalink
1.2.1-20231211
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

comanage-match/comanage-match-basic-auth/README.md

Go to file
 
 
Cannot retrieve contributors at this time
COmanage Match Basic Auth Build Arguments Build Requirements Building Building Example Volumes and Data Persistence Environment Variables Authentication Ports Running Logging HTTPS Configuration
132 lines (94 sloc) 4.03 KB
Raw Blame
Open in GitHub Desktop

COmanage Match Basic Auth

Intended to build a COmanage Match image using Apache HTTP Server Basic Auth (Basic Auth) as the authentication mechanism.

Basic Auth is only suitable for COmanage Match deployments not operating in a federated identity context, or for an introduction to COmanage Match.

See other documentation in this repository for examples on how to build images that support federated identity deployments.

Build Arguments

Building the image requires the following build arguments:

--build-arg COMANAGE_MATCH_VERSION=<version number>
--build-arg COMANAGE_MATCH_BASE_IMAGE_VERSION=<base image version number>

Build Requirements

This image uses a multi-stage build and requires that the COmanage Match base image be built first.

Building

docker build \
  --build-arg COMANAGE_MATCH_VERSION=<COmanage Match version number> \
  --build-arg COMANAGE_MATCH_BASE_IMAGE_VERSION=<base image version number> \
  -t comanage-match:<tag> .

Building Example

export COMANAGE_MATCH_VERSION=1.0.0
export COMANAGE_MATCH_BASE_IMAGE_VERSION=1
export COMANAGE_MATCH_BASIC_AUTH_IMAGE_VERSION=1
TAG="${COMANAGE_MATCH_VERSION}-basic-auth-${COMANAGE_MATCH_BASIC_AUTH_IMAGE_VERSION}" 
docker build \
  --build-arg COMANAGE_MATCH_VERSION=${COMANAGE_MATCH_VERSION} \
  --build-arg COMANAGE_MATCH_BASE_IMAGE_VERSION=${COMANAGE_MATCH_BASE_IMAGE_VERSION} \
  -t comanage-match:$TAG .

Volumes and Data Persistence

See COmanage Match Volumes and Data Persistence.

Environment Variables

See the list of environment variables common to all images including this image.

Authentication

This image supports using Apache HTTP Server Basic Auth (Basic Auth) as the authentication mechanism. To aid simple deployments for evaluating and learning COmanage Registry a password file with a single user and password is included. See the section above on environment variables.

To override the default bind mount or COPY in a password file created with the htpasswd command line tool. For example

COPY passwords /etc/apache2/passwords

Ports

The image listens for web traffic on ports 80 and 443. All requests on port 80 are redirected to port 443.

Running

See other documentation in this repository for details on how to orchestrate running this image with other images using an orchestration tool like Docker Compose, Docker Swarm, or Kubernetes.

To run this image:

docker run -d \
  --name comanage-match \
  -v /opt/comanage-match-local:/srv/comanage-match/local \
  -p 80:80 \
  -p 443:443 \
  comanage-match:1.0.0-basic-auth-1

Logging

Both Apache HTTP Server and COmanage Match log to the stdout and stderr of the container.

HTTPS Configuration

See the section on environment variables and the HTTPS_CERT_FILE and HTTPS_PRIVKEY_FILE variables.

Additionally you may bind mount or COPY in an X.509 certificate file (containing the CA signing certificate(s), if any) and associated private key file. For example

COPY cert.pem /etc/apache2/cert.pem
COPY privkey.pem /etc/apache2/privkey.pem