X hide

Smart Backup Script v1.x Configuration

From Plumrocket Documentation

You are viewing:  Smart-backup-script-plumrocket-32.png  Smart Backup Script

Contents


Smart Backup Script Configuration

Here you will learn how to configure Smart Backup Script by Plumrocket.

First of all you will need to enter the script path in your browser's address bar and follow this address. The path format is:

 www.yourdomain.com/smart-backup

where "yourdomain" is the name of your domain.


Information Sign sm.png Step-by-Step action:
  1. Input your Login. By default it will be set to root .
  2. Enter your Password. By default it will be set to root123 .
  3. Press LogIn button.


Smart backup script configuration1.png


Information Sign sm.png Step-by-Step action:
  1. In order to edit your profile information go to "My Account" tab.
  2. "Login": in this field enter your login.
  3. "New password": enter your new password.
  4. "Re New password": re-enter your new password.
  5. "Current password": enter your current password.
  6. Press "Save" button to save your changes.


1 smart backup solution configuration.jpg


Configuration

Information Sign sm.png Step-by-Step action:
  1. "Serial key": enter the serial key that can be found at your account at Plumrocket Store.
  2. "From mail": specify an e-mail the backup will be sent from.
  3. "Tar Path": enter the path to tar archive.
  4. "Delete logs after": specify number of the days the logs will be deleted after. Leave empty or set to "0" to keep all logs.
  5. Once you enabled "Use Auth" tab, you need to specify username in the "Username field".
  6. "Password": specify your password in this field.
  7. Once you enabled "Advanced SMTP" tab, you need to specify SMTP host in '"SMTP host" field.
  8. "SMTP port": enter SMTP port in this field.
  9. Press "Save" to save all the changes.


2 smart backup solution configuration.jpg


Connections Configuration

First of all you will need to create all necessary connections with your Smart Backup Script. In order to setup these connections please follow the instructions below.


Data Base connection setup


You can consider doing not only files backup, but data base backup too. In order to setup this type of connection please follow the steps below.

Information Sign sm.png Step-by-Step action:
  1. Select "Connections" tab in the main menu.
  2. Click on "Add New" button.
  3. Select the "Connection type" to be "Data Base".


Smart backup DataBase connection 1.png


Information Sign sm.png Step-by-Step action:
  1. Indicate the "Name" for your connection.
  2. Type in the name of "Host" that will be used. Note: in this case the database is located locally.
  3. Enter the proper "User" name for connection.
  4. Type in the "Password".
  5. Before saving this data, you can check if the connection has been setup properly by clicking the "Test connection" button.
  6. If your connection is setup properly - the "Connection success" popup will appear.
  7. Save your settings by clicking "Save" button.
  8. In case this connection is no longer required - you can delete it by clicking "Delete" button.
  9. After you save this connection - it will appear in the list.


Smart backup DataBase connection 2.png


Once you've setup the Data Base connection - the next step would be setting up Amazon S3 connection for reserved copies. In order to setup this type of connection please follow the steps below.


Amazon S3 connection setup


Information Sign sm.png Step-by-Step action:
  1. Select "Connections" tab in the main menu.
  2. Click on "Add New" button.
  3. Select the "Connection type" to be "Amazon S3".


Smart backup DataBase connection 3.png


Information Sign sm.png Step-by-Step action:
  1. Indicate the "Name" for your connection.
  2. Type in the "Access Key".
  3. Indicate the "Secret".
  4. Type in the "Bucket".
  5. Indicate the "Folder" that will be used for this connection.
  6. Before saving this data, you can check if the connection has been setup properly by clicking the "Test connection" button.
  7. If your connection is setup properly - the "Connection success" popup will appear.
  8. Save your settings by clicking "Save" button.
  9. In case this connection is no longer required - you can delete it by clicking "Delete" button.
  10. After you save this connection - it will appear in the list.


Smart backup DataBase connection 4.png


The next connection that is preferable to be setup is FTP connection. In order to setup this type of connection please follow the steps below.


FTP connection setup


Information Sign sm.png Step-by-Step action:
  1. Select "Connections" tab in the main menu.
  2. Click on "Add New" button.
  3. Select the "Connection type" to be "FTP".


Smart backup DataBase connection 5.png


Information Sign sm.png Step-by-Step action:
  1. Indicate the "Name" for your connection.
  2. Type in the "Host".
  3. Indicate the "User".
  4. Type in the "Password".
  5. Indicate the "Folder" that will be used for this connection.
  6. Type in the "Port".
  7. Before saving this data, you can check if the connection has been setup properly by clicking the "Test connection" button.
  8. If your connection is setup properly - the "Connection success" popup will appear.
  9. Save your settings by clicking "Save" button.
  10. In case this connection is no longer required - you can delete it by clicking "Delete" button.
  11. After you save this connection - it will appear in the list.


Smart backup DataBase connection 6.png


Once you've finished with FTP, you can move to establishing Google Storage connection. In order to setup this type of connection please follow the steps below.


Google Storage connection setup


Information Sign sm.png Step-by-Step action:
  1. Select "Connections" tab in the main menu.
  2. Click on "Add New" button.
  3. Select the "Connection type" to be "Google Storage".


Smart backup DataBase connection 7.png


Information Sign sm.png Step-by-Step action:
  1. Indicate the "Name" for your connection.
  2. Type in the "Access Key".
  3. Indicate the "Secret".
  4. Type in the "Bucket".
  5. Indicate the "Folder" that will be used for this connection.
  6. Before saving this data, you can check if the connection has been setup properly by clicking the "Test connection" button.
  7. If your connection is setup properly - the "Connection success" popup will appear.
  8. Save your settings by clicking "Save" button.
  9. In case this connection is no longer required - you can delete it by clicking "Delete" button.
  10. After you save this connection - it will appear in the list.


Smart backup DataBase connection 8.png


Once the Google Storage connection has been setup - you can proceed with setting up Local Folder connection. This one will allow to save reserved copies locally. In order to proceed please follow the steps below.


Local Folder connection setup


Information Sign sm.png Step-by-Step action:
  1. Select "Connections" tab in the main menu.
  2. Click on "Add New" button.
  3. Select the "Connection type" to be "Local Folder".


Smart backup DataBase connection 9.png


Information Sign sm.png Step-by-Step action:
  1. Indicate the "Name" for your connection.
  2. Indicate the "Folder" that will be used for this connection.
  3. Before saving this data, you can check if the connection has been setup properly by clicking the "Test connection" button.
  4. If your connection is setup properly - the "Connection success" popup will appear.
  5. Save your settings by clicking "Save" button.
  6. In case this connection is no longer required - you can delete it by clicking "Delete" button.
  7. After you save this connection - it will appear in the list.


Smart backup DataBase connection 10.png


Periodicity Configuration

After all needed connections have been setup - you can proceed by setting the backup periodicity. In order to proceed please follow the steps below.

Daily Backup setup

Information Sign sm.png Step-by-Step action:
  1. Select "Periodicity" tab in the main menu.
  2. Click on "Add New" button.
  3. Give a "Name" for your daily backup.
  4. "When to run" drop-down allows select the period you need to run the backup for.
  5. In order not to perform backup at the weekends check "Do not Backup on Weekends" checkbox.
  6. "Number of Backups to Maintain" option allows to set the number of backups that will be maintained.
  7. Save your settings by clicking "Save" button.
  8. In case Daily Backup is no longer required - you can delete it by clicking "Delete" button.
  9. After you save Daily Backup - it will appear in the list.


Magento smart backup daily backup .jpg

Weekly Backup setup

Information Sign sm.png Step-by-Step action:
  1. Click on "Add New" button.
  2. Give a "Name" for your weekly backup.
  3. "When to run" drop-down allows select the period you need to run the backup for.
  4. "Day of week" allows to select the day of the week you need the backup to start from.
  5. "Number of Backups to Maintain" option allows to set the number of backups that will be maintained.
  6. Save your settings by clicking "Save" button.
  7. In case Weekly Backup is no longer required - you can delete it by clicking "Delete" button.
  8. After you save Weekly Backup - it will appear in the list.


Magento smart backup weekly backup.jpg


Groups Configuration

You can add, change or delete Groups in this section. Different settings for each group are available. In order to set up a new Group please follow the steps below.

Information Sign sm.png Step-by-Step action:
  1. Select "Groups" tab in the main menu.
  2. Click on "Add New" button.
  3. Name: Indicate the name of your new group.
  4. Active Backup: Tick this box if you want to make backup for this group active.
  5. Active Mail Report: Tick this box if you want to email backup reports to some specific email addresses.
  6. Subject: Indicate the subject of the Smart Backup's email report.
  7. Mails: List of email addresses the Smart Backup's email report will be sent to.
  8. Save your group by pressing the "Save" button.
  9. Saved group will appear in the list of groups on the left.
  10. Press "Delete" button to remove current group.

Smart backup script configuration2.png


Projects Configuration

"Projects" tab, it is the final setting of each backup. Follow the instructions below to set it up correctly.


Information Sign sm.png Step-by-Step action:
  1. Go to "Projects" tab.
  2. Enter name of your website.
  3. Select from the drop-down a group to assign this project to.
  4. Specify description of this project in the "Description" field.
  5. Check "Active mail report" check-box. Specify subject of the report. Enter email addresses the report should be sent to.
  6. Select the backup type from the options available."
  7. Check "Active database backup" check-box and select "Add connection".
  8. Select "Database connection" type. You can add several connections or several databases.
  9. Select "Database name".
  10. Select tables to exclude from the backup.
  11. Check "Active files&folders backup" check-box.
  12. Specify paths to the files and folders the backup will be generated from.
  13. Specify path exceptions to the files and folder, which will be excluded from the backup.
  14. Select the storage locations you need the backup to be saved to.
  15. Press "Save" button to save your project.


Smart backup solution by plumrocket.jpg


Log

Information Sign sm.png Step-by-Step action:
  1. In order to check your logs go to "Log" tab.
  2. In Projects filter tab you can search for the project you need to check the logs for.
  3. Enter the dates of the period you need to check the logs for.
  4. Check "Only with errors" checkbox to display logs only with errors. Leave empty checkbox in order to show all logs for the selected dates.
  5. This field shows logs for the project you selected. You can view and delete the required logs.


3 smart backup solution configuration.jpg


This is how your logs file looks like after you pressed "View" button.


Smart backup script configuration log.jpg


Once you have configured Smart Backup, you need set up Cron Job. You can read more on how to set up Cron Job here.

Here are the commands you need to add to the Cron tab:

30 0 * * * php /path/to/smart-backup/runBackup.php part1 > /dev/null 2>&1
0 1 * * * php /path/to/smart-backup/runBackup.php part2 > /dev/null 2>&1
30 1 * * * php /path/to/smart-backup/runBackup.php part3 > /dev/null 2>&1
0 2 * * * php /path/to/smart-backup/runBackup.php part4 > /dev/null 2>&1
30 2 * * * php /path/to/smart-backup/runBackup.php part5 > /dev/null 2>&1
Navigation