# mongo-backup-to-s3

> stream mongodb backups to S3, with ease

Latest version **1.1.3** (published 2016-01-07) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install mongo-backup-to-s3
pnpm add mongo-backup-to-s3
yarn add mongo-backup-to-s3
bun add mongo-backup-to-s3
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2016-01-07 |
| First published | 2015-12-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Brad Oyler |
| Maintainers | bradoyler |
| Keywords | mongodb, dump, backup, streaming, s3 |

## Links

- npm: https://www.npmjs.com/package/mongo-backup-to-s3
- Repository: http://github.com/bradoyler/mongo-backup-to-s3
- Homepage: https://github.com/bradoyler/mongo-backup-to-s3
- Issues: https://github.com/bradoyler/mongo-backup-to-s3/issues
- npm.io page: https://npm.io/package/mongo-backup-to-s3

## Dependencies (4)

- [moment](https://npm.io/package/moment.md) ^2.10.6
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.2.26
- [memorystream](https://npm.io/package/memorystream.md) ^0.3.1
- [mongo-dump-stream](https://npm.io/package/mongo-dump-stream.md) ^0.3.3

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.1.3 (latest) — 2016-01-07
- 1.1.2 — 2016-01-05
- 1.1.1 — 2016-01-03
- 1.1.0 — 2015-12-31

## README

# Mongo Backup to S3
Easily stream mongodb backups to S3

[![NPM Version][npm-image]][npm-url]

## Motivation
Explore an inexpensive way to backup your MongoDb databases

## Get Started
Setup an S3 bucket, run this in a cron job using a Heroku Single Dyno (worker)

### Install
```sh
npm install mongo-backup-to-s3
```

Example:
```
var mongoBackup = require('mongo-backup-to-s3');

var config = {
    mongodb:{
        url: process.env.MONGO_URL
    },
    s3:{
        bucket:'mybucket',
        folder:'backups',
        key: process.env.AWS_ACCESS_KEY,
        secret: process.env.AWS_SECRET_KEY
    }
};

mongoBackup.dumpToS3(config);
```

Generated filename in S3: `backups/mongo_2015-12-30_22-16-34_mydatabase.dmp`

## Dependent modules
This module relies heavily on [mongo-dump-stream](https://github.com/punkave/mongo-dump-stream) so it can output the 'dump' to a stream, and so we don't have to use `mongodump` (which requires a child process).

[npm-image]: https://img.shields.io/npm/v/mongo-backup-to-s3.svg
[npm-url]: https://npmjs.org/package/mongo-backup-to-s3

---
_Source: https://npm.io/package/mongo-backup-to-s3 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._