Update Readme.md
This commit is contained in:
parent
f71fb416fa
commit
fbfc08b623
39
README.md
39
README.md
|
@ -7,11 +7,42 @@ S3 backed storage strategy for greenlock-express.js (and greenlock.js)
|
|||
|
||||
## Requirements
|
||||
|
||||
- AWS Account
|
||||
- S3 Bucket
|
||||
- Access to S3 Bucket via the AWS CLI (accessKeyId, secretAccessKey)
|
||||
You will need:
|
||||
1. S3 Bucket (<a href="https://aws.amazon.com/s3/" target="_blank">more info.</a>)
|
||||
2. AWS API credentials with read and write access to the bucket (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html" target="_blank">more info.</a>)
|
||||
|
||||
For more information see https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
||||
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
|
||||
|
||||
```javascript
|
||||
|
||||
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
|
||||
|
||||
|
|
Loading…
Reference in New Issue