https://github.com/theworkflow/s3-mongodump

Perform mongodump on database host and send backup to s3
https://github.com/theworkflow/s3-mongodump

Last synced: 11 months ago
JSON representation

Perform mongodump on database host and send backup to s3

• Host: GitHub
• URL: https://github.com/theworkflow/s3-mongodump
• Owner: theworkflow
• License: mit
• Created: 2017-02-03T14:32:21.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-11-28T06:30:15.000Z (over 8 years ago)
• Last Synced: 2025-07-19T21:21:09.097Z (12 months ago)
• Language: JavaScript
• Size: 30.3 KB
• Stars: 0
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# s3-mongodump

[![version](https://img.shields.io/npm/v/s3-mongodump.svg?style=flat-square)][version]

[![build](https://img.shields.io/travis/theworkflow/s3-mongodump/master.svg?style=flat-square)][build]

[![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]

Perform mongodump on database host and send backup to s3

## Install

`$ npm install -g s3-mongodump`

### CLI Usage

  Usage: s3-mongodump [options]

  Options:

    -h, --help                           output usage information

    -V, --version                        output the version number

    -h, --host               Host connection to mongo database host

    -u --username              DB host admin username

    -p, --password             DB host admin password

    --oplog                              Oplog flag for mongodump command

    -o --output                    Output path to store tar file

    -b --bucket                  AWS bucket location (includes path to uploaded folder)

    --accessKeyId           AWS accessKeyId

    --secretAccessKey   AWS secretAccessKey

    --retry                      Number of time to retry on sending backup to S3

### API Usage

```javascript

const Backup = require('s3-mongodump')

Backup(options, (err) => {

  if (err) throw err

})

```

## Contributing

Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first.

## License

[MIT](LICENSE.md)

[version]: https://www.npmjs.com/package/s3-mongodump

[build]: https://travis-ci.org/theworkflow/s3-mongodump

[license]: https://raw.githubusercontent.com/theworkflow/s3-mongodump/master/LICENSE