@studyportals/goldeneye-ssl-cdk

GoldenEye SSL CDK

This library is used to create the CDK resources for running the GoldenEye SSL check. The check is run periodically and the results are reported back to the associated GitHub Pull Request.

Run the SSL Check locally

To run the SSL check locally, you need to set the following environment variables:

• SSL_PUBLISHER_IMAGE - pointing to the goldeneye-ssl-publisher Docker image
• REPORTS_S3_BUCKET
• DOMAIN
• SERVICE_DESCRIPTOR

You also need to inject valid AWS credentials that are authorized to upload to the desired S3 bucket:

• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY
• AWS_SESSION_TOKEN
• AWS_REGION

Once the environment variables are set, you can run the SSL check using Docker Compose with the following command:

yarn docker

Working with GoldenEye

Update the @studyportals/goldeneye-ssl-cdk in GoldenEye package.json's references to point to this folder via the portal protocol. For example:

"@studyportals/goldeneye-ssl-cdk": "portal:/home/dan/workspace/studyportals/goldeneye-ssl/cdk"

Run yarn watch to watch for changes and build the package or yarn build to just build the package once.

Publishing

To publish the NPM package, run yarn publish and follow the prompts.