https://github.com/jsreport/jsreport-aws-s3-storage
jsreport extension adding support for storing blobs in aws s3
https://github.com/jsreport/jsreport-aws-s3-storage
Last synced: about 1 year ago
JSON representation
jsreport extension adding support for storing blobs in aws s3
- Host: GitHub
- URL: https://github.com/jsreport/jsreport-aws-s3-storage
- Owner: jsreport
- Created: 2018-10-14T20:38:34.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-20T16:31:58.000Z (almost 5 years ago)
- Last Synced: 2025-03-27T11:43:34.864Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://jsreport.net
- Size: 43.9 KB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**⚠️ This repository has been moved to the monorepo [jsreport/jsreport](https://github.com/jsreport/jsreport) and to the npm `@jsreport/jsreport-aws-s3-storage` scope.**
--
# jsreport-aws-s3-storage
[](https://npmjs.com/package/jsreport-aws-s3-storage)
[](https://travis-ci.org/jsreport/jsreport-aws-s3-storage)
> jsreport extension adding support for storing blobs in aws s3
Some of the jsreport extensions requires a blob storage for storing binary objects. This implementation stores these objects like output reports inside cost effective aws s3.
See the blob storages general documentation
https://jsreport.net/learn/blob-storages
See how to persist jsreport output reports
https://jsreport.net/learn/reports
## Installation
> npm install jsreport-aws-s3-storage
## Configuration
Required options is:
- `bucket`
In case you want to use IAM role, don't pass accessKey and secretAccessKey.
Optionally you can set
- `s3Options`: options passed to [asws sdk s3 constructor](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property)
```js
{
"blobStorage": {
"provider": "aws-s3-storage"
},
"extensions": {
"aws-s3-storage": {
"accessKeyId": "...",
"secretAccessKey": "...",
"bucket": "...",
"s3Options": {...}
}
}
}
```
## jsreport-core
```js
var jsreport = require('jsreport-core')({ blobStorage: { provider: 'aws-s3-storage' } })
jsreport.use(require('jsreport-aws-s3-storage')({...}))
```