Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sierrasoftworks/minback-mongo
A container which provides the ability to backup a MongoDB database to Minio on demand
https://github.com/sierrasoftworks/minback-mongo
backup docker minio mongodb s3
Last synced: 27 days ago
JSON representation
A container which provides the ability to backup a MongoDB database to Minio on demand
- Host: GitHub
- URL: https://github.com/sierrasoftworks/minback-mongo
- Owner: SierraSoftworks
- Created: 2017-09-25T14:41:24.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-12-09T23:49:30.000Z (about 1 month ago)
- Last Synced: 2024-12-10T00:28:48.389Z (about 1 month ago)
- Topics: backup, docker, minio, mongodb, s3
- Language: Shell
- Size: 85.9 KB
- Stars: 11
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# minback-mongo
**Minio Backup container for MongoDB**
This container provides a trivially simple means to run `mongodump` and fire the results off
to a [Minio][] instance. It is intended to be run in conjunction with a [Kubernetes CronJob][]
to maintain a frequent backup of your critical data with minimal fuss.
## Features
* Dumps a single MongoDB database to an S3 bucket
* Lightweight and short lived
* Simple and readable implementation
* Optional encryption for archive file
## Example
```sh
docker run --rm --env-file backup.env minback/mongo my_db -h mongoserver1
```
#### `backup.env`
```
MINIO_SERVER=https://play.minio.io/
MINIO_ACCESS_KEY=minio
MINIO_SECRET_KEY=miniosecret
MINIO_BUCKET=backups
```
## Usage
```
DB_NAME [OPTIONS...]
Arguments
DB_NAME - The name of the database you wish to backup
OPTIONS - Any additional options you wish to pass to mongodump
```
## Configuration
This container is configured using environment variables, enabling it to easily be started
manually or automatically and integrate well with Kubernetes' configuration framework.
#### `MINIO_SERVER=https://play.minio.io/`
The Minio server you wish to send backups to.
#### `MINIO_ACCESS_KEY=minio`
The Access Key used to connect to your Minio server.
#### `MINIO_SECRET_KEY=miniosecret`
The Secret Key used to connect to your Minio server.
#### `MINIO_BUCKET=backups`
The Minio bucket you wish to store your backup in.
#### `ENCRYPTION_KEY`
(Optional) The OpenSSL symmetric key to protect the archive with. Should be sufficiently long to prevent dictionary based attacks.
### `DATE_FORMAT=+%Y-%m-%d`
The date format you would like to use when naming your backup files. Files are named `$DB-$DATE.archive`.
[Kubernetes CronJob]: https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/
[Minio]: https://minio.io/