---
title: "Deploy MYSQL & MONGODB Backup to S3 Service"
description: "Quick backup your Mysql or MongoDB to any S3 service."
category: "Automation"
url: https://railway.com/deploy/mysql-backup-to-s3-service
---

# Deploy MYSQL & MONGODB Backup to S3 Service

Quick backup your Mysql or MongoDB to any S3 service.

**[Deploy MYSQL & MONGODB Backup to S3 Service on Railway](https://railway.com/template/mysql-backup-to-s3-service)**

- **Creator:** Kuba's Projects
- **Category:** Automation
- **Total deploys:** 1

## Template content

### mysql-backup-to-s3

- **Source:** poziomekk/mysql-mongodb-backup-to-s3

## Documentation

# mysql-mongodb-backup-to-s3
Quick Backup your MySQL and MongoDB to any S3 Service 

[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/H41sm5?referralCode=poziomus&utm_medium=integration&utm_source=template&utm_campaign=generic)

# MySQL & MongoDB Backup to S3

A lightweight Node.js service that creates compressed backups of MySQL and MongoDB databases and uploads them to any S3-compatible object storage.

The service connects directly to MySQL/MongoDB, generates dumps, compresses them using gzip, and stores the backups as `.sql.gz` or `.gz` files in an S3 bucket. It is designed to run on Railway but can be deployed anywhere.

## Features

- Supports MySQL and MariaDB
- Supports MongoDB
- Uploads backups to any S3-compatible storage
- Creates compressed `.sql.gz` (MySQL) and `.gz` (MongoDB) backups
- Can back up a single database or all databases
- Stateless and easy to deploy
- Works well with cron-based scheduling (e.g. Railway cron jobs)

## How It Works

### MySQL

1. Connects to a MySQL database
2. Generates SQL dump(s) for one or more databases
3. Compresses the dump using gzip
4. Uploads the backup file to an S3 bucket
5. Cleans up temporary files

### MongoDB

1. Connects to MongoDB using a connection URI
2. Generates a dump for the specified database (or all non-system databases)
3. Compresses the dump using gzip
4. Uploads the backup file to an S3 bucket
5. Cleans up temporary files

Each backup is stored with a timestamped filename.

## Environment Variables

### S3 Configuration

- `AWS_ACCESS_KEY_ID`  
  S3 access key ID

- `AWS_SECRET_ACCESS_KEY`  
  S3 secret access key

- `AWS_S3_BUCKET`  
  Target S3 bucket name

- `AWS_S3_REGION`  
  S3 bucket region

- `AWS_S3_ENDPOINT` *(optional)*  
  Custom endpoint for S3-compatible providers (MinIO, Backblaze, etc.)

### MySQL Configuration

- `MYSQL_ENABLED`  
  Enable MySQL backup (`true` to enable, default: `true`)

- `BACKUP_DATABASE_HOST`  
  Database host

- `BACKUP_DATABASE_PORT`  
  Database port

- `BACKUP_DATABASE_USER`  
  Database user

- `BACKUP_DATABASE_PASSWORD`  
  Database password

- `BACKUP_DATABASE_NAME` *(optional)*  
  Database name to back up  
  Leave empty to back up all databases (excluding system databases)

### MongoDB Configuration

- `MONGODB_ENABLED`  
  Enable MongoDB backup (`true` to enable, default: `false`)

- `MONGODB_URI` *(required when MongoDB is enabled)*  
  MongoDB connection string  
  If the URI includes a database name it will be backed up; otherwise all non-system databases are backed up  
  Example: `mongodb://user:password@host:27017/mydb`

### Scheduling & Debug

- `BACKUP_CRON_SCHEDULE`  
  Cron schedule for automatic backups  
  Default: `0 5 * * *`

- `DEBUG` *(optional)*  
  Enable verbose logging (`1` to enable)

## Deployment

### Railway (Recommended)

1. Create a new Railway project
2. Deploy this repository
3. Add the required environment variables
4. (Optional) Configure a Railway cron job using `BACKUP_CRON_SCHEDULE`

### Manual

```bash
npm install
npm run build
node dist/index.js
```


## Similar templates

- [N8N Main + Worker](https://railway.com/deploy/n8n-main-worker) — Deploy and Host N8N with Inactive worker.
- [Evolution API with n8n](https://railway.com/deploy/evolution-api-with-n8n) — Build a WhatsApp automation platform with Evolution API, n8n & Postgres.
- [Postgres Backup](https://railway.com/deploy/postgres-s3-backups) — Cron-based PostgreSQL backup to bucket storage

Open this page in a browser: https://railway.com/deploy/mysql-backup-to-s3-service