mirror of
				https://github.com/cderche/greenlock-storage-s3
				synced 2025-10-31 04:22:46 +00:00 
			
		
		
		
	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
Description
				
					Languages
				
				
								
								
									JavaScript
								
								100%