Skip to content

1 Setup

Umberto Russo edited this page Mar 18, 2019 · 1 revision

Requirement

This app use the AWS CLI "sync" command, this mean that you must install the AWS CLI in order to use this app.

You can find the AWS CLI installer here: Download AWS CLI

Installation

Download the latest stable release here: https://github.com/ulver2812/aws-s3-backup/releases

It's preferred to download and install the one click installer version (e.g. aws-s3-backup-setup-1.5.0.exe ) in this way you can benefit of the auto update feature.

Setup

After installation go to settings page and configure the app.

AWS Settings

In order to use the app you must set an "AWS access key ID", an "AWS secret access key" and an "AWS Region" that you can create through the IAM service in the AWS console.

The IAM user needs a programmatic access account with a correct read/write S3 policy attached (e.g AmazonS3FullAccess) and CloudWatch Metrics (e.g CloudWatchReadOnlyAccess).

You can use any IAM S3 policy that grant access to the S3 buckets that you want to use with the app and CloudWatch.

Here an example policy: IAM S3 example policy

S3 Settings

  • Max concurrent request: The aws s3 transfer commands are multithreaded. At any given time, multiple requests to Amazon S3 are in flight. The max concurrent requests specifies the maximum number of transfer commands that are allowed at any given time. Decreasing this value will make the S3 transfer commands less resource intensive the amount of time needed for backup may increase. On the other hand Increasing this value may speed up the backup process.
  • Max bandwidth: This controls the maximum bandwidth that the S3 commands will utilize when streaming content data to and from S3.

Notification Settings

  • Allow notifications: enable the email notifications about the jobs status
  • Email host: smpt host
  • Email port: smtp port
  • Email secure layer: enable the smtp secure layer support (SSL/TLS)
  • Email user: smtp username
  • Email password: smtp password
  • Email sender: email sender
  • Email receivers: a list of email receivers

App Settings

  • Start on OS boot: allow the auto start on OS boot
Clone this wiki locally