Prism Backup

A backup utility for backing up databases and files to S3 cloud storage.

Installation

Install globally using npm i -g prism-backup

Alternatively use npx prism-backup to run the latest version without installation.

Usage

1. Create your configuration file.
2. Run prism-backup --config path/to/config/file.yml.

For scheduled backups this command can be run via a cron job or similar system.

Configuration

Example configuration.yml:

id: backup-id
reporting:
  webhook:
    endpoint: https://webhook.url.com/endpoint
    key: REPORTING_WEBHOOK_KEY
connect:
  endpoint: s3.example.com
  key: ACCESS_KEY_ID
  secret: SECRET_ACCESS_KEY
  bucket: bucket-name
files:
- label: file-group-name
  paths:
  - /path/to/directory
  - /path/to/single-file.txt
- label: second-file-group
  paths:
  - /path/to/another-file.txt
databases:
- label: database-backup-name
  type: mysql
  host: localhost
  username: foo
  password: bar
  database: baz

Uploading to storage

The connect object configures the S3 storage connection details.

For use with DigitalOcean spaces, use the spaces key and spaces secret as the key and secret respectively.

File backups

Groups of file and directory paths can be defined in files to allow more control of the structure of your backup.

Each group can have multiple paths and will group all under one zip archive within the backup.

File paths can either be absolute paths or relative to the location of the configuration file.

Database backups

Multiple databases details can be defined in databases.

Note: Currently only MySQL databases are supported

Reporting

An optional reporting webhook can be provided in reporting to report successful backup uploads and any errors.

Example success webhook POST payload:

{
  "id": "backup-id",
  "upload": {
    "bucket": "bucket-name",
    "object": "20210830-105654_backup-id_27213.zip",
  },
  "key": "REPORTING_WEBHOOK_KEY"
}

Example error webhook POST payload:

{
  "id": "backup-id",
  "error": "Error message",
  "key": "REPORTING_WEBHOOK_KEY"
}