greenlock-challenge-s3

S3 backed challenge strategy for greenlock-express.js (and greenlock.js)

Usage no npm install needed!

<script type="module">
  import greenlockChallengeS3 from 'https://cdn.skypack.dev/greenlock-challenge-s3';
</script>

README

CircleCI Maintainability Test Coverage Known Vulnerabilities

"Lifetime Downloads" "Monthly Downloads" "Weekly Downloads"

greenlock-challenge-s3

S3 backed challenge strategy for greenlock-express.js (and greenlock.js)

Requirements

You will need a s3 bucket and the corresponding credentials.

Integration

greenlock-express.js


let challenge = require('greenlock-challenge-s3').create({
    accessKeyId: accessKeyId                // Replace with your accessKeyId
    , secretAccessKey: secretAccessKey      // Replace with your secretAccessKey
    , regionName: regionName                // Replace with your regionName
    , bucketName: bucketName                // Replace with your bucketName
    , directory: 'acme-challenge/'          // Recommended
    , debug: true                           // Debug
});

var Greenlock = require("greenlock-express");

var greenlock = Greenlock.create({
    // Other options
    , challenges: {
        'http-01': challenge
    }
});

// Continue your greenlock setup

Testing

The strategy is tested against the greenlock-challenge-test

To run the tests yourself, create a .env file with the following

// .env file
AWS_ACCESS_KEY_ID=abc           // Replace with your accessKeyId
AWS_SECRET_ACCESS_KEY=abc       // Replace with your secretAccessKey
AWS_BUCKET_REGION=abc           // Replace with your regionName
AWS_BUCKET_NAME=abc             // Replace with your bucketName

Run the following command:

$ npm run clean && npm run test && npm run clean

License

ISC