Nestjs-backup-tool NPM

nestjs-backup-tool

A comprehensive backup solution for NestJS applications supporting multiple databases and storage methods.

Features

🗄️ Multiple Database Support
- MySQL
- PostgreSQL
📦 Multiple Storage Options
- Local File System
- FTP Server
- Amazon S3
⚙️ Advanced Features
- Scheduled backups using cron expressions
- Configurable retention policy
- Optional web UI for backup management
- Email notifications
- Async configuration support

Prerequisites

Before using this package, make sure you have the following installed:

For MySQL Backups

# For Debian/Ubuntu
sudo apt-get update
sudo apt-get install mysql-client or sudo apt-get install mariadb-client

# For macOS
brew install mysql-client

# For Windows
# Install MySQL Workbench or MySQL Command Line Client

For PostgreSQL Backups

# For Debian/Ubuntu
sudo apt-get update
sudo apt-get install postgresql-client

# For macOS
brew install postgresql

# For Windows
# Install PostgreSQL client tools

Installation

npm install nestjs-backup-tool

Usage

Basic Configuration

import { Module } from '@nestjs/common';
import { BackupModule } from 'nestjs-backup-tool';

@Module({
  imports: [
    BackupModule.register({
      database: {
        type: 'mysql',
        host: 'localhost',
        user: 'root',
        password: 'password',
        database: 'mydb'
      },
      storage: [
         { type: 'local', path: './backups' },
        {
          type: 's3',
          bucketName: 'my-backups',
          region: 'us-east-1',
          accessKeyId: 'YOUR_ACCESS_KEY',
          secretAccessKey: 'YOUR_SECRET_KEY',
        }
      ],
      schedule: '0 2 * * *', // Daily at 2 AM
      retentionDays: 30,
      enableUI: true,
      notifications: {
        enabled: true,
        email: {
          from: 'backup@example.com',
          to: ['admin@example.com'],
          smtp: {
            host: 'smtp.example.com',
            port: 587,
            auth: {
              user: 'smtp-user',
              pass: 'smtp-password'
            }
          }
        }
      }
    }),
  ],
})
export class AppModule {}

Configuration Options

Database Configuration

type: 'mysql' or 'postgres'
host: Database host
user: Database username
password: Database password
database: Database name

Storage Options

Local Storage
- type: 'local'
- path: Local directory path
FTP Storage
- type: 'ftp'
- host, user, password, port
S3 Storage
- type: 's3'
- bucketName, region, accessKeyId, secretAccessKey