ec-backup

EC Backup (easy-backup)

If you need a system easy to use that provides you a periodic (or at specific time) backup. This is your package.

Requirements

Right now this package is tested only on Ubuntu 20.04 LTS and you need to have the following packages in order to work:

• zip: sudo apt install zip
• Mongo Database Tools (only in case that your backup is from MongoDB)
  • Tested version: 100.5.2

How to install

Just npm i -g ec-backup or use it with npx ec-backup

How to use

• First you need to create the config file that ec-backup will read its instructions (see section below for this).
• You can validate your config file with: ec-backup validate -f <yourconfigfilepath>

One single time

If you want to backup only one time (or to verify that your process works well) just: ec-backup backup -f <yourconfigfilepath>

Also, you can use --dry to do not notify and upload your backup zip, but you can check that backup file is created where you specify in the config:

Cron

To create the process you must specify an ID, some examples:

• ec-backup cron --id example-id -f <yourconfigfilepath>: create a cron process
• ec-backup cron --stop --id example-id: try to stop a cron process with id example-id
• ec-backup cron --list: list all current cron precesses

Config

Configuration file is split in 3 main parts:

• Backup engine: what kind of data source we will backup
  • mongo: backup your database from MongoDB
  • file: choose files from your system to backup
• Notificator: how do you want to be notified
  • telegram: uses a channel and a bot to notify all your backups
  • console: just print to console
• Uploader: where we put your fresh backup
  • gcp: Google Cloud Storage
  • none: drop it where you specified in outputDir field

Skeleton

Use following examples (backup engines, notificator, uploader) to make your own config file, here is the skeleton:

{
   "cron": "* * * * * *", // Cron schedule expression (https://crontab.guru)
   "outputDir": "/tmp", // Temporary folder to store your backup until upload
   "engine": { ... } // Backup engine config,
   "notificator": { ... } // Notificator config,
   "uploader": { ... } // Uploader config
}

Backup engines

mongo

{
  "type": "mongo",
  "databaseHost": "", // Host name of your MongoDB
  "databasePort": 27017, // [Optional] Database port. Defaults to 27017
  "databaseName": "",
  "username": "" // [Optional] In case that your DDBB needs auth
  "password": "" // [Optional]
}

file

{
  "type": "file",
  "path": "" // Path to drop out the zipped backup
}

Notificator

Telegram

{
  "type": "telegram",
  "chatId": "", // ID of the chat where you want to be notified
  "botToken": "" // Token ID (without "bot" prefix in case that have) (https://core.telegram.org/bots)
}

Note: You can obtain the chatId from this URL: https://api.telegram.org/bot/getUpdates. Substitute <putYourToken> with your bot token

Console

{
  "type": "console"
}

Uploader

Google Cloud Storage

{
  "type": "gcp",
  "storageKeyPath": "", // JSON Key file that authenticate your program on GCP
  "backupsFolderPath": "", // [Optional] Name of the folder inside the bucket to put the backup. Defaults to "backups"
  "bucketName": "",
  "projectId": ""
}