Cloud Backup for Joomla

Transcription

1 Cloud Backup for Joomla Release: January, 2013 Version: 2.1

2 By -

3 1

4 Installation 1. Download the extensions from our website 2. Extract the downloaded archive using your favorite file compression software, such as WinRAR. You will find following 3 (three) extension: a) The Cloud Backup Component (com_cloudbackup_v2.1_j2.5.zip) b) The Cloud Backup plug in for Google Drive (plg_cloudbackup_gdrive_v2.1_j2.5.zip) c) The Cloud Backup System plug in (plg_system_cloudbackup_v2.1_j2.5.zip) 1

5 3. Go to your Joomla site s administrator panel, e.g Go to Extension Manager in the Administrator main menu. Note: You might not see this menu option if you do not have sufficient permission on the site. For more information read Joomla access right management. 5. Browse your computer for Cloud Backup component installer (com_cloudbackup_v2.1_j2.5.zip) and click on the Upload & Install button. 6. After installing these extensions successfully, you will see the Cloud Backup component in the Components menu. 7. Similarly browse for the remaining two installers (plg_system_cloudbackup_v2.1_j2.5.zip and plg_cloudbackup_gdrive_v2.1_j2.5.zip) one by one and install. 2

6 8. After installing these extensions successfully, you will see the Cloud Backup component in the Components menu and the plug ins in the Plug in Manager. 9. That s it! You have just installed Cloudbackup, the awesome solution for your website schedule backup task. Next you will know how to configure it to perform it the way you like to. 3

7 Configure Google API To use Google Drive for you storage of your backup files you will need to create a project at Google APIs Console. After this you will obtain the API keys that will be used for the configuration of the Cloud Backup Extension. Follow these steps to create an API project on Google APIs. 1. Go to Google APIs Console at You might need to login into your Google account (your Gmail login credentials will work) If this is not your first API project then you might not see the following screen. In that case go to next screen. 2. When you see the following screen. Click on the top left dropdown which shows the current active project. 1

8 3. If this is your first project you might wish to rename this to some meaningful (by default, API Project), or create a new project for Cloud Backup API. I will start with the create option. 4. Enter a name for the project and submit. After that your API project will be created. 5. Click on the services tab (in left pane) and you turn the status button to ON for the Drive API. You might need to accept the Google API Terms and Conditions to proceed. 6. Now switch to the API Access tab and click Create a OAuth2.0 Client ID button. 2

9 7. Fill out the form in the popup window. You only need to enter the name for the Product e.g. Cloud Backup. Remaining fields, viz. Your Logo URL and the Homepage URL are optional. Click next when you are done. 8. On the next page you will set the remaining settings for this Client ID. Choose Web Application as the Application Type. And click on more options to expand the form. 9. After clicking the more options link the form will ask you to fill the list of allowed redirect URIs. These are very important as they control the permissions of this API with the Cloud Backup extension installed on you site. Enter the following URLs in the Authorized Redirect URIs field. Write each URL in a separate line. Keep the Authorized JavaScript origin field empty. 3

10 Cloud Backup v2.0 for Joomla /administrator/index.php?option=com_cloudbackup&task=config.receivetoken /administrator/index.php?option=com_cloudbackup&task=config.receivetoken /administrator/index.php?option=com_cloudbackup&task=config.receivetoken /administrator/index.php?option=com_cloudbackup&task=config.receivetoken 10. Finally click on the Create client ID. Your OAuth client ID will be created and you will be taken to the following page. Take a note of the Client ID and the Client Secret from here. You will need these two things to configure you Cloud Backup installation on your website. Warning: Never share your client ID and client secret with anybody. This should be entered at the appropriate field in the Cloud Backup component installed on your site only. If you ever need to modify the authorized Redirect URIs, you should go to edit settings link on the right hand side. Or you think your client secret has been compromised you can click on Reset client secret link. And afterwards update the new client secret in your cloud backup configuration. 11. That s alll for the Google API configuration. Now you have the Client ID and Client Secret for your Google Drive API. 12. Next you will learn how to configure your Cloud Backup installation with these API keys. Bh ti W b T h l i bh ti 4

11 Configure Cloud Backup API access Now you are in possession of the API keys for your Google Drive API. Follow these steps to configure your Cloud Backup installation. 1. Go back to your website s administrative panel, e.g Open the Cloud Backup component interface from Main menu Components Cloud Backup. 3. Click on the settings button (with a Google Drive Icon) on the Cloud Backup toolbar. This will take you to the Google Drive API Configuration page. 4. Enter the Client ID and Client Secret you just created at the Google APIs console. Then click on the Retrieve button to grant the Cloud Backup access to your Google Drive account. This will take you to the Google s Request for Permission page. 5. The Cloud Backup extension requests the following permission for its operation: a) View and manage the files and documents in your Google Drive b) View your address c) Perform these operations when You're not using the application 1

12 Cloud Backup v2.0 for Joomla 6. When you ensure that the request is for the same OAuth API thatt you created and the requested permissions are the same as documented heree then you should click Allow Accesss button. 7. After thatt an access token will be generated and passed to the Cloud Backup extension whichh you will be able to see on the configuration n page. 8. Finally click on Save & Close on the right top of the Component toolbar to save the credentials. 9. Now you have configured the API access to the Cloud Backup extension. In the next section we will describe how to create Backup Profiles for your website backups. Bh ti W b T h l i bh ti 2

13 Create or manage Cloud Backup Profiles Cloud Backup for Joomla v2.0 will create a backup of you website periodically including the files and the database. For this you will need to create one or more backup schedules with different settings (described later). These schedules are referred to as Backup Profiles for Cloud Backup. Having multiple profiles lets you backup different set of data at different time schedules. You can also choose the frequency of each profile independently. This gives you website backup a great flexibility. 1. Open the Cloud Backup component s interface from Main menu Components Cloud Backup Profiles or from the Profiles Tab in the component interface itself. 2. Click on New to create a new backup profile. If you had had any existing profile you could also choose to edit it as well. 1

14 3. Next you will see a form in which you should set all the values as per your requirements. a) Choose the backup interval from the list. b) Choose the type of backup, i.e. Database only, Files only or Both Files and Database. c) Enter the name of destination folder on Cloud storage (e.g. Google Drive) d) Files and folders that should be excluded from the backup done with this profile. Each files and folders specified here should be separated with a new line. The file and folder names should be all relative to your Joomla site root (where the main index.php is located). For example: images/products media/catalogue/commercial configuration.php e) Enter the names of the database tables you do not want to backup in this schedule. Each table name should be written in a separate line. Do not include your table prefix (like jos_) in the table names here. For example: if your database prefix is j25_ and you do not want to backup j25_weblinks then you should enter weblinks only. 4. After this click on Save & Close to save this profile. 5. Similarly you can create as many profiles as you wish. The backups will pick up one profile each time and perform a backup according to the set settings if the schedule time has arrived. You can always enable or disable any profile anytime and that will not be considered for the backups. So you never need to delete them if you ever plan to re enable it later. 2

15 6. Now you have done all the stuffs needed to configure you Cloud Backup installation. Now move on to the last step. 3

16 Enable Cloud Backup Plug ins To perform a regular backup of your website you need to enable the Cloud Backup plug ins, viz. 1) The Cloud Backup System plug in (plg_system_cloudbackup_v2.1_j2.5.zip) 2) The Cloud Backup plug in for Google Drive (plg_cloudbackup_gdrive_v2.1_j2.5.zip) To do this, follow these steps: 1. Go to the Plug in Manager in your Joomla Site Administrator panel. 2. Select the 2 plug ins in the list of plug ins and click on Enable button on the Plug in Manager s toolbar. 3. After this you have your Cloud Backup up and running. You can see the backup files (once created) on your Google Drive account. 1

17 Backup List View In the last section we showed you that you can see the backup files on the Google Drive account. But you can also see your backup history in the Cloud Backup component interface. 1. Go to the Cloud Backup main component interface. There you will see all the details of the backup files created so far. 2. You can also filter the list using a search keyword, a date limit or a backup type (like file backup or a database backup). 3. On the Location column for each backup file there is a Google Drive Icon. Place your mouse over it to see the account / user account under which the file has been uploaded. 4. You can also download the backup files right from here without a need to login into your Google account. To download the file click on the Google Drive Icon for that file. That s all for the ultimate Cloud Backup solution for your precious Joomla website. 1