SQL Backup Master Help

Online Documentation

Custom S3 Compatible

The SQL Backup Master Custom S3 Compatible backup destination allows you to store database backups with a wide (and quickly expanding) range of S3-compatible storage services. This includes on-premises S3 compatible storage offerings such as Cloudian, Ceph, and many others.

To create a Custom S3 Compatible backup destination within SQL Backup Master, click the Add toolbar button in the Destinations section of the Database Backup Editor window. When prompted to choose a destination, select Custom (S3) and click the Select button.

Authentication

S3 storage providers require entry of an Access Key and a Secret Key for authentication purposes. You'll also need to provide the name of an existing bucket – SQL Backup Master will not create the bucket for you.

For details on where to find this information, please consult your S3 compatible storage service provider or product documentation.

Service Configuration

The following service configuration options are available:

  • Service address - The S3 service endpoint URL (e.g. https://s3.example.com). This field is required. If you omit the protocol, https:// is assumed.
  • Signature version - Choose between Signature v2 (the default) and Signature v4 request signing. Most modern S3-compatible services support (and some require) Signature v4.
  • Bucket addressing - Choose between path-style addressing (the default) and virtual host style addressing. Most self-hosted S3-compatible systems use path-style addressing.
  • Upload method - Multipart (the default) uploads files in parallel parts and supports automatic retry. The "Direct object stream" option uploads each file in a single request and should be used for small backups only (e.g. with services that don't support the S3 multipart upload API).
  • Enable upload integrity checks - Enabled by default. Verifies the integrity of uploaded data using checksums. Disabling this option reduces CPU usage at the cost of upload verification.

For details about which options your storage service requires, please consult your S3 compatible storage service provider or product documentation.

Remaining Configuration

Please see the Amazon S3 help topic for discussion of the remaining configuration options.