https://github.com/jesusthehun/lisk-plugin-backup
Backup your forger info into S3 buckets
https://github.com/jesusthehun/lisk-plugin-backup
backup blockchain lisk
Last synced: about 1 year ago
JSON representation
Backup your forger info into S3 buckets
- Host: GitHub
- URL: https://github.com/jesusthehun/lisk-plugin-backup
- Owner: JesusTheHun
- Created: 2021-04-29T10:46:13.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-02T11:37:08.000Z (about 5 years ago)
- Last Synced: 2025-06-20T05:07:57.871Z (about 1 year ago)
- Topics: backup, blockchain, lisk
- Language: TypeScript
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Lisk Plugin Backup
## Installation
```bash
npm install lisk-plugin-backup
# or
yarn add lisk-plugin-backup
```
## Getting started
```js
// src/application/index.js
import { BackupPlugin } from 'lisk-plugin-backup';
app.registerPlugin(BackupPlugin);
```
## Usage
Once configured, the plugin will backup the data when appropriate.
Currently, only `forger-info` are supported, and they will be backup'ed every time you forge a block.
## Configuration
The plugin is designed to support a number of ways to backup the data.
So far only the `s3` adapter is available.
```js
// src/application/index.js
const appConfig = utils.objects.mergeDeep({}, configDevnet, {
plugins: {
"backup": {
"forgerInfo": {
"enable": true,
"adapter": "s3",
"adapterParams": {
"accessKey": "YOUR_ACCESS_KEY",
"privateKey": "YOUR_PRIVATE_KEY",
"region": "YOUR_REGION",
"endpoint": "YOUR_BUCK_HOSTNAME_WITHOUT_SCHEME",
"objectPath": "DESTINATION_PATH",
"metadata": { // arbitratry metadata for the S3 object
"chain": "MY_CHAIN_NAME",
"network": "devnet"
}
}
}
}
},
});
const app = Application.defaultApplication(genesisBlockDevnet, appConfig);
```