gl-store-s3.js/README.md

1.8 KiB

CircleCI Codacy Badge Known Vulnerabilities

greenlock-storage-s3

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

Requirements

You will need:

  1. S3 Bucket (more info.)
  2. AWS API credentials with read and write access to the bucket (more info.)

You will need to pass the following information to greenlock-storage-s3

  1. Your accessKeyId
  2. Your secretAccessKey
  3. Your regionName
  4. Your bucketName

Integration

greenlock-express.js


let store = require('./index').create({
    accessKeyId: accessKeyId                // Your accessKeyId
    , secretAccessKey: secretAccessKey      // Your secretAccessKey
    , regionName: regionName                // Your regionName
    , bucketName: bucketName                // 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

License

ISC