Skip to content

Commit

Permalink
Changed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ulver2812 committed Mar 9, 2019
1 parent 7232bc3 commit fb3536e
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,43 @@
[![AWS S3](./aws_s3.png)](https://aws.amazon.com/s3/)
<p align="center">
<img src="https://raw.githubusercontent.com/ulver2812/aws-s3-backup/master/aws-s3-backup-icon.png" alt="AWS S3 Backup"/>
</p>

[![Make a pull request][prs-badge]][prs]
[![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE)
[![Tested](https://img.shields.io/badge/tested%20on-Win%2010%20x64-brightgreen.svg)]()

# Introduction

This app allow you to use Amazon AWS Simple Storage Service (S3) as backup system for desktop environment.
This app allows you to use AWS (Amazon Web Services) S3 as backup system for desktop environments.
Like Dropbox or Google Drive app you can backup your important data on AWS S3.
This desktop app allow you to configure 3 different types of backup job (One time, recurring, live) to backup your data in an S3 bucket.
This desktop app allows you to configure 3 different types of backup job (One time, recurring, live) to backup your data in an S3 bucket.

- **One time:** the backup job will be executed only one time as programmed.
- **Recurring:** the backup job will be executed periodically as programmed.
- **Live:** any time a file associated with the backup job changes it will be transferred to the S3 bucket.

The app is designed with Electron and Angular so you can use it on Windows, Mac and Linux.
This is a cross platform app, built with Electron, so you can use it on Windows, Mac and Linux.

## Requirement

This app rely on AWS CLI to use the efficient "sync" command, this mean that you need to install the AWS CLI on your own in order to use this app.
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](https://aws.amazon.com/cli/)

## APP Settings

After installation go to settings page and configure the AWS credentials.

In order to use the app you must set an "AWS access key ID" and an "AWS secret access key" that you can create through the [IAM service](https://docs.aws.amazon.com/en_us/IAM/latest/UserGuide/introduction.html) 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 buckets that you want to use with the app.
Here an example policy: [IAM S3 example policy](https://docs.aws.amazon.com/en_us/IAM/latest/UserGuide/reference_policies_examples_s3_rw-bucket.html)

## How to correctly quit the app

When you try to quit the app the normal behaviour is that the app minimize herself in the icons tray and still run.
To correctly quit the app right click on the tray icon and click "quit".

<img src="preview.gif">

## Windows executable (portable and installer)
Expand Down Expand Up @@ -76,22 +92,6 @@ Don't forget to deactivate the "Developer Tools" by commenting `win.webContents.
|`npm run electron:windows`| On a Windows OS, builds your application and creates an app consumable in windows 32/64 bit systems |
|`npm run electron:mac`| On a MAC OS, builds your application and generates a `.app` file of your application that can be run on Mac |

## AWS app settings

In order to use the app you need to set in the settings page an "AWS access key ID" and an "AWS secret access key" 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 buckets that you want to use with the app.
Here an example policy: [IAM S3 example policy](https://docs.aws.amazon.com/en_us/IAM/latest/UserGuide/reference_policies_examples_s3_rw-bucket.html)

## To correctly quit the app

When you try to quit the app the normal behaviour is that the app minimize herself in the tray icon and still run.
To correctly quit the app right click on the tray icon and click "quit".

## More information

This app is built with the [maximegris/angular-electron](https://github.com/maximegris/angular-electron)
project, for more information visit the repo.

[license-badge]: https://img.shields.io/badge/license-Apache2-blue.svg?style=flat
[license]: https://github.com/ulver2812/aws-s3-backup/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
Expand Down
Binary file added aws-s3-backup-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed aws_s3.png
Binary file not shown.

0 comments on commit fb3536e

Please sign in to comment.