README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-cloudfront-auth

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - cloudfront
  - s3
  - auth
  - cloudfront-auth

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "ISC"

# Copyrights
copyrights:
  - name: "The Scale Factory Ltd."
    url: "https://scalefactory.com"
    year: "2019"
  - name: "Widen Enterprises"
    url: "https://www.widen.com/"
    year: "2017"

# Canonical GitHub repo
github_repo: scalefactory/terraform-cloudfront-auth

# Screenshots
screenshots:
 - name: "Example"
   url: "/docs/code.png"
   description: "Example using GitHub authentication"

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/scalefactory/terraform-cloudfront-auth.svg"
    url: "https://github.com/scalefactory/terraform-cloudfront-auth/releases/latest"
  - name: "License"
    image: "https://img.shields.io/badge/License-ISC-blue.svg"
    url: "https://opensource.org/licenses/ISC"

# References
references:
  - name: "Widen - Cloudfront Auth"
    description: "This project wraps Terraform around Widen's cloudfront-auth around"
    url: "https://github.com/Widen/cloudfront-auth/"
  - name: "Terraform"
    description: "Infrastructure as code"
    url: "https://terraform.io"

# Short description of this project
description: |-
  A Terraform module to provision a Cloudfront distribution to serve private
  content in an S3 bucket with Lamba@Edge Google/Microsoft/Github/Okta/Auth0/Centrify
  authentication. Based on [Widen - Cloudfront Auth](https://github.com/Widen/cloudfront-auth/)

# Introduction to the project
introduction: |-
  You should use this module if you have a private S3 bucket that you want to
  guard with Google/Microsoft/Github/Okta/Auth0/Centrify authentication.

  The Terraform packages up
  [cloudfront-auth](https://github.com/Widen/cloudfront-auth/) into a Lambda
  function to be used by Cloudfront's
  [Lambda@Edge](https://aws.amazon.com/lambda/edge/). A private S3 bucket and
  Cloudfront Distribution will also be created.

# How to use this project
usage: |-
  **NOTE**: You will need to create a certificate with AWS Certificate Manager in
  the `us-east-1` region. The example below assumes a certificate for the domain
  `example.com` already exists.

  ```hcl
  module "cloudfront_auth" {
    source                         = "git::https://github.com/scalefactory/terraform-cloudfront-auth.git?ref=master"

    auth_vendor                    = "github"
    cloudfront_distribution        = "private.example.com"
    client_id                      = "CHANGE_ME"
    client_secret                  = "CHANGE_ME"
    redirect_uri                   = "https://private.example.com/callback"
    github_organization            = "exampleorg"

    bucket_name                    = "private.example.com"
    region                         = "eu-west-1"
    cloudfront_acm_certificate_arn = "${data.aws_acm_certificate.example.arn}"
  }

  data "aws_acm_certificate" "example" {
    domain   = "example.com"
    statuses = ["ISSUED"]
  }
  ```

# Example usage
examples: |-
  A Full working example can be found in [example](./example) folder. Please
  update the `cloudfront_auth` module parameters. **NOTE**: The certificate will
  need validating with email first.

# Other files to include in this README from the project folder
include:
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: "Steve Porter"
    github: "steveporter92"