Skip to content

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

Notifications You must be signed in to change notification settings

kdby-io/greenlock-storage-s3

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CircleCI Maintainability Test Coverage Known Vulnerabilities

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

greenlock-storage-s3

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

Requirements

You will need a s3 bucket and the corresponding credentials.

Integration

greenlock-express.js

let store = require('greenlock-storage-s3').create({
    accessKeyId: accessKeyId                // Replace with your accessKeyId
    , secretAccessKey: secretAccessKey      // Replace with your secretAccessKey
    , bucketRegion: bucketRegion            // Replace with your bucketRegion
    , bucketName: bucketName                // Replace with your bucketName
    , configDir: 'acme/'                    // Recommended
    , accountsDir: 'accounts/'              // Recommended
    , debug: true                           // Debug
});

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

var greenlock = Greenlock.create({
    // Other options
    , store: store
});

// Continue your greenlock setup

Testing

The strategy is tested against the greenlock-store-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 bucketRegion
AWS_BUCKET_NAME=abc             // Replace with your bucketName

Run the following command:

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

License

ISC

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%