cloud backup by amasty. user guide

53
User Guide: Cloud Backup Page 1 Cloud Backup Support: http://amasty.com/contacts/ Magento Extension User Guide Official extension page: Cloud Backup

Upload: amasty

Post on 22-Nov-2014

982 views

Category:

Technology


3 download

DESCRIPTION

Effectively protect your site from any data loss. Use flexible settings to automatically copy and store the whole database or particular files on a separate server with easy and prompt access.

TRANSCRIPT

Page 1: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup

Page 1

Cloud Backup

Support: http://amasty.com/contacts/

Magento Extension User Guide

Official extension page: Cloud Backup

Page 2: Cloud Backup by Amasty. User Guide

Table of contents:

1. Create backup profile……………………………………..………………………. 3 2. Profile details…………………………………………………………………….……4 3. Storage application………………………………………………..………………..5 4. Multiple steps……………..…………………………………………………..………6 5. DB table exclusion…………………………….……………………………………..7 6. Files and directories exclusion.…………………………………………….……8 7. Cron scheduled tasks………………………………….…………………………….9 8. Delete setiings………………………………….…………………………………….10 9. Logs Settings…………….………………………………………………………….…11 10. Authentication settings………………………….………………………………..12 11. Backup creation…...………………………………………………………………...13 12. Amazon S3 service settings………………………………………………………15 13. Google Drive settings………………………………………………………………30 14. Dropbox application settings……………………………………………………38 15. Box application settings…………………………………………………………..45

Page 2 Support: http://amasty.com/contacts/

User Guide: Cloud Backup

Page 3: Cloud Backup by Amasty. User Guide

Page 3

Here you can create new and edit already existing backup profiles. To start editing the profile just click on its name.

Support: http://amasty.com/contacts/

1. Create backup profile

To create a backup profile or see the default one please go to Backup->Profiles

User Guide: Cloud Backup

IMPORTANT: If you install the extension using FTP, make sure the compilation is disabled. After the installation - if you have Magento cache turned on -clear cache by pressing “Flush Cache Storage” button.

Page 4: Cloud Backup by Amasty. User Guide

Page 4 Support: http://amasty.com/contacts/

2. Profile details

Choose the backup type: files and database, database only or files only.

User Guide: Cloud Backup

Set this option to “yes” if you want to set this profile a default one

Specify the way to the directory where the temporary files will be saved.

Page 5: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 5 Support: http://amasty.com/contacts/

3. Storage application At this tab you can choose the cloud storage you need and specify necessary settings it.

Specify the file size that the backup will be divided into.

Set the option to “yes” if you want to save backup files on the server where the site is located.

Page 6: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 6 Support: http://amasty.com/contacts/

4. Multiple Steps

You use the multistep option either in manual mode or with the help of cron.

Please specify the step interval for the backup process.

Page 7: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 7 Support: http://amasty.com/contacts/

Please specify which Magento tables should not be included in backups.

5. DB Tables Exclusion

Click here to calculate the disc space required for each database table.

Page 8: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 8

Specify the files/folders that shouldn’t be added to the backup.

Support: http://amasty.com/contacts/

6. Files and directories exclusion

Calculate the disc space required for the files/folders.

Page 9: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 9 Support: http://amasty.com/contacts/

7. Cron scheduled tasks

Here you can specify the settings to run scheduled backup by cron – these settings are similar to the native Magento ones.

IMPORTANT: If you need to run the scheduled backup for Dropbox storage you need to authorize the the Dropbox app first. To authorize the app specify “Storage Application Settings” and click the “Save and authorize” button.

Page 10: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 10 Support: http://amasty.com/contacts/

8. Delete Settings

You can delete old backups in two ways: Rotation type deletes the files after the number of backups exceeds the determined number. The Delete Old type removes the old backups after a particular time period.

Here you can specify the email address of a sender and recipient to get notified about the backup successful completion or error.

Choose the template for success and error emails. To create a template please go to System-> Transactional Emails.

Page 11: Cloud Backup by Amasty. User Guide

Page 11

Specify the directory to store the profile backup logs.

Support: http://amasty.com/contacts/

9. Logs Settings

User Guide: Cloud Backup

Choose the backup process login level.

There are 4 log levels: All - post in logs all backup messages; Info - post in logs all backup messages except for “Debug”; Warnings & Errors – fill in logs Warnings & Errors only; Off – disable logging (it can speed up the backup process up to 10%-20%)

Page 12: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 12 Support: http://amasty.com/contacts/

10. Authentication Settings

In case your site is protected with Apache authentication please set this option to “yes”.

Page 13: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 13 Support: http://amasty.com/contacts/

11. Backup Creation

To create a backup please go to Backup -> Backups and click on the “Create Backup” button.

Page 14: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 14

Please specify the backup name. In case you leave the field empty, the name will be generated automatically.

Support: http://amasty.com/contacts/

11. Backup creation

Here you can leave comments and notes for your personal needs.

In this window you can observe the progress of the backup process.

Page 15: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 15 Support: http://amasty.com/contacts/

12. Amazon S3 service settings •To create the AmazonS3 service settings go to aws.amazon.com/S3/

•If you are not logged in or registered, Amazon will offer to authorize first.

Page 16: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 16 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

Fill in the fields in the opened window. Insert the following data:

· User name

· Email address

· Password

Then click the “Continue” button.

Page 17: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 17 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

Once you have logged in, insert your credit card details and follow the instruction to setup your account. After that click on the “Continue” button.

Page 18: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 18 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

Enter your contact information and a security check:

Page 19: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 19 Support: http://amasty.com/contacts/

12. Amazon S3 service settings In order to complete the sign-up process, Amazon will need to verify your identity. Follow the

instructions on the screen.

Page 20: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 20 Support: http://amasty.com/contacts/

12. Amazon S3 service settings Once you are done signing up, you’ll be greeted with a page that says your account has been created and information has been sent to your email.

Page 21: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 21 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

Look for Amazon Simple Storage Service (S3) in the list, click it.

Page 22: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 22 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

Read it again if you need, or just skip to signing up an account by clicking on the Sign up Now.

Page 23: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 23 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

Congrats! You`ve got an access to Amazon Simple Storage Service.

Page 24: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 24 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

Then go to the AWS Management Console > Amazon S3

Page 25: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 25 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

Now you should be able to manage Amazon S3 buckets and objects. You should create a bucket. For example, you can notice in the image that a new bucket “amasty” was created.

Page 26: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 26 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

Now it’s possible to create a directory. Directory can be created manually or with the

Cloud Backup extension in automated mode. Choose one of the options to create a

directory.

Page 27: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 27 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

Find the tab labeled as Security Credentials.

Page 28: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 28 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

Find the tab labeled as Your Secret Access Key and click on the Show button. Your secret access key will appear.

Page 29: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 29 Support: http://amasty.com/contacts/

12. Amazon S3 service settings

After you have installed the Backup extension on Magento, copy the secret access key and

go to the Backup extension setting: Magento->Profile information->Storage application tab.

Choose the AmazonS3 option and fill in the Access Key and Secret Key fields.

In a Bucket Directory field define the Amazon folder where the backup files will be copied to.

Page 30: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 30 Support: http://amasty.com/contacts/

13. Google Drive settings

To be able to start configuration, receive Client ID and Client Secret for your application on Google API console.

Go to https://cloud.google.com/console#/project

Page 31: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 31 Support: http://amasty.com/contacts/

13. Google Drive settings

Please fulfill SMS verification (if necessary):

Page 32: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 32 Support: http://amasty.com/contacts/

13. Google Drive settings

Receive code and verify:

Page 33: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 33 Support: http://amasty.com/contacts/

13. Google Drive settings

On the page of your just created project go to APIs & auth ‐> Registered apps.

Page 34: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 34 Support: http://amasty.com/contacts/

13. Google Drive settings

Enable Drive API and Drive SDK:

Page 35: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 35 Support: http://amasty.com/contacts/

13. Google Drive settings

Register a NEW App:

Page 36: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 36 Support: http://amasty.com/contacts/

13. Google Drive settings

Please enter the data as it’s shown on the picture below:

Page 37: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 37 Support: http://amasty.com/contacts/

13. Google Drive settings

Now you’ve got a Client ID and a Client secret.

Page 38: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 38 Support: http://amasty.com/contacts/

13. Google Drive settings

In Magento admin area go to Magento‐>Profile Information ‐> Storage Application.

Select Google Drive as a storage Application. You will also need to fill Client ID and Client Secret fields as it’s

shown on the picture below:

Page 39: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 39 Support: http://amasty.com/contacts/

14. Dropbox application settings

To create the Dropbox application go to https://www.dropbox.com/developers/apps.

If you are not logged in or registered, Dropbox will offer to authorize first.

Page 40: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 40 Support: http://amasty.com/contacts/

14. Dropbox application settings

To create the Dropbox application go to https://www.dropbox.com/developers/apps.

If you are not logged in or registered, Dropbox will offer to authorize first.

Page 41: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 41 Support: http://amasty.com/contacts/

14. Dropbox application settings Once you have logged in, go to My Apps page and click Create on the App button to create a new application. The app

creation dialog box will appear:

NOTE: Select full Dropbox Access Level radio button. It is required for Backup extension to create folders where backup files will go to. If Access level is not set to full Dropbox, we cannot guarantee correct extension functioning.

Page 42: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 42 Support: http://amasty.com/contacts/

14. Dropbox application settings

Specify Application settings:

Page 43: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 43 Support: http://amasty.com/contacts/

14. Dropbox application settings Once the application is created, you’ll be redirected to the App information page with the App Key and App Secret. Copy these data and go to Backup extension settings: Profile>Storage Application>Dropbox and set up the profile.

In the Dropbox directory field indicate the name of the folder in your Dropbox account (not the URL path). The connection timeout should not exceed the 100 value. Press Save and Authorize button.

Page 44: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 44 Support: http://amasty.com/contacts/

14. Dropbox application settings

Return to Dropbox and press “Apply” button to activate the app.

Page 46: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 46 Support: http://amasty.com/contacts/

15. Box application settings

Click the “Get API Key” button on the right‐hand side.

NOTE: If you are not logged in or registered, Box will offer to authorize first.

Page 47: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 47 Support: http://amasty.com/contacts/

15. Box application settings

Once you have logged in you have the possibility to create the application.

1. Insert application’s name.

2. Press the “Create App” button to create a new App.

Congrats! You have successfully created the Box Application!

Page 48: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 48 Support: http://amasty.com/contacts/

15. Box application settings

Click on the "Edit this application” button. Then you will see the application settings page.

Page 49: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 49 Support: http://amasty.com/contacts/

15. Box application settings

On the Backend Parameters page copy your API.

Then insert your site URL to the “Redirect url” field, this url should indicate where the extension will return after initial authorization. The URL should look like this:

http://yoursite.com/index.php/admin/mpbackup_backup/callback

Page 50: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 50 Support: http://amasty.com/contacts/

15. Box application settings

Save current settings.

Page 51: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 51 Support: http://amasty.com/contacts/

15. Box application settings Once you have installed the MagePlace Backup extension on Magento website go to the Backup extension setting: Magento‐>Profile information‐>Storage application tab:

Once you have entered information in all the required above‐mentioned fields click the “Save and authorize” button to continue.

Page 52: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup Page 52 Support: http://amasty.com/contacts/

15. Box application settings Congrats! Your profile was successfully saved!

Page 53: Cloud Backup by Amasty. User Guide

User Guide: Cloud Backup

Thank you!

Your feedback is absolutely welcome!

Page 53

Should you have any questions or feature suggestions, please contact us at:

http://amasty.com/contacts/

Support: http://amasty.com/contacts/