s3-dir-backup

    1.2.1 • Public • Published

    Overview

    s3-dir-backup is a shell tool for backing up a source directory to a destination S3 bucket.

    Features

    • Uploads large backup files using multipart uploads
    • SMTP notifications (gmail SMTP is default)
    • OS agnostic
    • Backup scheduling (default is daily at midnight)
    • Logging and rotation

    Prerequisites

    • Node.js
    • AWS credentials with permissions:
      S3: GetObject
      S3: PutObject
      S3: CreateBucket
      S3: PutLifecycleConfiguration
      S3: ListBuckets
      
    • R/W permissions for the directory you want to backup

    Getting Started

    1. Install s3-dir-backup using npm install -g s3-dir-backup

    Basic Usage

    s3-dir-backup -s <sourceDirectory> -d <destinationBucketName>

    • sourceDirectory is the directory you want to back up
    • destinationBucketName is the name of the S3 bucket you want to back up to.
    • If the S3 bucket you specify doesn't exist you will be prompted to confirm if you want s3-dir-backup to create it for you

    Backup Scheduling

    s3-dir-backup -s <sourceDirectory> -d <destinationBucketName> --backup-schedule <cronExpression>

    • The --backup-schedule or -c flag allows you to input a cron expression to use as the backup schedule
    • If a custom backup schedule is not set s3-dir-backup will back up daily at midnight

    SMTP Notifications

    s3-dir-backup -s <sourceDirectory> -d <destinationBucketName> --notify --secure

    • The --notify flag enables SMTP notifications (smtp is default)
    • The --secure flag enables TLS usage. If you do not specify a custom SMTP_HOST and SMTP_PORT through env variables or inline then s3-dir-backup will use smtp.gmail.com:465 with secure enabled by default

    SMTP Parameters


    Using Environment Variables

    • Set up your SMTP credentials using environment variables

      For Windows

      setx SMTP_HOST smtp.somedomain.com
      setx SMTP_PORT 465
      setx SMTP_USER notificationuser@gmail.com
      setx SMTP_PW notifcationuser@gmail password
      setx SMTP_RECEIVERS receiver1@email.com,receiver2@someotheremail.com
      

      For MacOS or Linux

      • Exports will not persist unless you put them in your ~/.bash_profile, ~/.bashrc or /etc/environment
      • Please make sure you understand the differences between the files referenced above before setting your credentials there
      export SMTP_HOST="smtp.somedomain.com"
      export SMTP_PORT="465"
      export SMTP_USER="notificationuser@gmail.com"
      export SMTP_PW="notifcationuser@gmail password"
      export SMTP_RECEIVERS="receiver1@email.com,receiver2@someotheremail.com"
      

    Set SMTP Parameters Inline (temporary)

    s3-dir-backup -s <sourceDirectory> -d <destinationBucketName> -su <smtpUser> -spw <smtpPw> -sr <commaSeparatedSmtpReceivers>

    • -sh sets your SMTP host address (smtp.gmail.com is default)
    • -sp sets your SMTP port (465 is default)
    • -su sets your SMTP user/email account
    • -spw sets your SMTP password
    • -sr sets the receivers for notifcations separated by commas
    • SMTP parameters set inline do not persist between runs

    Logging

    • Backup logs can be found in the ~/.s3-dir-backup directory for macOS and Linux and %USERPROFILE%/.s3-dir-backup for Windows
    • Starts a new log daily up to 30 logs, rotates if a log manages to reach 10mb

    S3 Bucket Expiration Policy

    • Objects 7 days and older are expired
    • Multipart uploads that have not completed are terminated in 1 day

    Notes

    • If you are using a gmail account as the SMTP sender you must go to https://myaccount.google.com/security and allow less secure app access to allow s3-dir-backup to actually send emails using that account

    Install

    npm i s3-dir-backup

    DownloadsWeekly Downloads

    1

    Version

    1.2.1

    License

    ISC

    Unpacked Size

    27.9 kB

    Total Files

    12

    Last publish

    Collaborators

    • elenaek