https://github.com/jsreport/jsreport-fs-store-aws-s3-persistence
Make jsreport fs store persisting entities to aws s3
https://github.com/jsreport/jsreport-fs-store-aws-s3-persistence
Last synced: about 1 year ago
JSON representation
Make jsreport fs store persisting entities to aws s3
- Host: GitHub
- URL: https://github.com/jsreport/jsreport-fs-store-aws-s3-persistence
- Owner: jsreport
- Created: 2017-11-18T20:54:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-08T20:30:28.000Z (over 4 years ago)
- Last Synced: 2025-03-27T11:43:36.902Z (about 1 year ago)
- Language: JavaScript
- Size: 141 KB
- Stars: 5
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
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)**
--
# jsreport-fs-store-aws-s3-persistence
[](https://npmjs.com/package/jsreport-fs-store-aws-s3-persistence)
[](https://travis-ci.org/jsreport/jsreport-fs-store-aws-s3-persistence)
**Make jsreport [fs store](https://github.com/jsreport/jsreport-fs-store) persisting entities into AWS S3.**
## Installation
> npm install jsreport-fs-store
> npm install jsreport-fs-store-aws-s3-persistence
Create an IAM user with permissions to S3 and SQS and copy the access key and secret access key.
Create a bucket and copy its name. Then alter the jsreport configuration:
```js
"store": {
"provider": "fs"
},
"extensions": {
"fs-store": {
"persistence": {
"provider": "aws-s3"
},
// it is typically good idea to increase the compacting flat files interval from 5000
// otherwise store does too many locks which can be slow when s3 not in the same datacenter
"compactionInterval": 20000
},
"fs-store-aws-s3-persistence": {
"bucket": "...",
// the rest is otional
"accessKeyId": "...",
"secretAccessKey": "...",
"lock": {
"queueName": "jsreport-lock.fifo",
"region": "us-east-1",
"enabled": true,
"attributes": {}
},
"s3Options": {
// additional s3 constructor options
"maxRetries": 10
}
}
}
```
This persistence implementation also guarantees consistency for parallel access from multiple instances. This is assured using locking mechanism enabling only single write at once. The locking is implemented trough AWS SQS. The queue is automatically created during the instance startup with attributes specified in the configuration `lock`. You can disable it by setting `false` to `lock.enabled`.