root
/
gl-store-s3.js
mirror of https://github.com/cderche/greenlock-storage-s3
2
0
Fork 0
Code Issues 1 Releases Wiki Activity

Update README.md

This commit is contained in:
cyrille 2019-05-08 15:51:26 +01:00 committed by GitHub
parent a828c3fbac
commit c1f92a6253
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -16,10 +16,10 @@ You will need a s3 bucket and the corresponding credentials.
```javascript ```javascript
let store = require('greenlock-storage-s3').create({ let store = require('greenlock-storage-s3').create({
accessKeyId: accessKeyId // Your accessKeyId accessKeyId: accessKeyId // Replace with your accessKeyId
, secretAccessKey: secretAccessKey // Your secretAccessKey , secretAccessKey: secretAccessKey // Replace with your secretAccessKey
, regionName: regionName // Your regionName , regionName: regionName // Replace with your regionName
, bucketName: bucketName // Your bucketName , bucketName: bucketName // Replace with your bucketName
, configDir: 'acme/' // Recommended , configDir: 'acme/' // Recommended
, accountsDir: 'accounts/' // Recommended , accountsDir: 'accounts/' // Recommended
, debug: true // Debug , debug: true // Debug
@ -44,13 +44,16 @@ To run the tests yourself, create a `.env` file with the following
``` ```
// .env file // .env file
AWS_ACCESS_KEY_ID=abc // Your accessKeyId AWS_ACCESS_KEY_ID=abc // Replace with your accessKeyId
AWS_SECRET_ACCESS_KEY=abc // Your secretAccessKey AWS_SECRET_ACCESS_KEY=abc // Replace with your secretAccessKey
AWS_BUCKET_REGION=abc // Your regionName AWS_BUCKET_REGION=abc // Replace with your regionName
AWS_BUCKET_NAME=abc // Your bucketName AWS_BUCKET_NAME=abc // Replace with your bucketName
``` ```
Run the following command: `npm run clean && npm run test && npm run clean` Run the following command:
```console
$ npm run clean && npm run test && npm run clean
```
## License ## License