advertisement
Online Backup Client User Manual
For Linux distributions
Software version 4.1.7
Version 2.0
Disclaimer
This document is compiled with the greatest possible care. However, errors might have been introduced caused by human mistakes or by other means. No rights can be derived from possible inaccuracies or errors as this is not a contractual agreement, but for information only. All rights reserved; nothing may be duplicated or reproduced without written permission of BackupAgent BV.
Online Backup Client User Manual
1. Contents
© BackupAgent 2012 Page 2 of 28
Online Backup Client User Manual
© BackupAgent 2012 Page 3 of 28
Online Backup Client User Manual
2. Product Information
Product:
Version:
Online Backup Client for Linux
4.1.7
2.1 System Requirements
Operating System
Hardware Resources
Required software
Linux (RedHat, SuSE, Debian and Debian based systems such as Ubuntu)
Solaris 10
Solaris 11
PC with 1 gigahertz (GHz) or higher processor clock speed recommended
1,5 GB memory
25 MB of disk space
Internet connection (e.g. ADSL, SDSL)
Java 1.6 platform or higher is required
Note: A separate manual is available for the Online Backup Client for Microsoft Windows and Mac
OS X.
Note: There are two types of accounts: Workstation (Home) and Server (Professional). Only the
Server account is available for use with the Linux client.
© BackupAgent 2012 Page 4 of 28
Online Backup Client User Manual
3. Features
The Online Backup Client has several features. It supports different kinds of data. It can backup normal data but also specific data.
You can make one or more scheduled tasks to backup data automatically (e.g. daily, weekly).
The Online Backup Client fully supports all Linux file formats and user rights.
The Online Backup Service also includes a Management Console, which can be accessed through an
Internet browser. It has several functions:
Change user settings (e.g. password).
Overview of your backups through logs and reports.
© BackupAgent 2012 Page 5 of 28
Online Backup Client User Manual
4. Setup
4.1 Software installation
Currently there is no package available for Linux. Setup of the Online Backup Client is performed using the following instructions:
Copy the Online Backup Client archive (OnlineBackupClient-4.0.X.x.tar.gz) to your system and place it in your $HOME directory. create a new directory: mkdir $HOME/OnlineBackupClient change to this directory and extract the archive: cd $HOME/OnlineBackupClient tar xzf $HOME/OnlineBackupClient-4.0.X.x.x.tar.gz
This will create the two following folders:
Server/ This folder contains the Online Backup Service component.
Client/ This folder contains the user-interface application for the Online
Backup Client.
CommandLine This folder contains the CommandLine client part of the Backup
Client.
Start the Online Backup Service: cd $HOME/OnlineBackupClient /Server
./server-with-logging.sh
This will start the Online Backup Client Service and place it in the background.
Here you will be asked to enter your (sudo) password, so the Online Backup Client can access all the files.
Start the Online Backup Client User Interface: cd $HOME/OnlineBackupClient/Client
./client-with-logging.sh
This will start the Online Backup Client User Interface and, if this is a first-time installation, present you with the Registration Wizard.
Note: After the setup, you can adjust the language of the Online Backup Client.
© BackupAgent 2012 Page 6 of 28
Online Backup Client User Manual
4.2 Registration Wizard
When the Online Backup Client is started for the first time, it will start with the Registration Wizard.
The Registration Wizard guides you to fill in the account information and encryption key. With the encryption key your data will be encrypted and decrypted.
Figure 1: Registration wizard
You need to fill in the address of the Backup Server to connect to; your Online Backup Provider will provide you with this address. You can test the address by clicking on ‘Test’.
Figure 2: Backup Server Address
You need to fill in the username and password that you created or obtained from your Online
Backup Provider.
Note: You also have to fill in a Computer name. This which will be registered at the Backup Server to store all files.
© BackupAgent 2012 Page 7 of 28
Online Backup Client User Manual
Figure 3: User account
Note: If you do not remember your password you can click on the link below the Username text field. A reminder will then be sent to your registered email address.
Note: If there is a problem with the username and password, the Online Backup Client will show a prompt that signing in is not possible. There can be several reasons for this to occur:
The username and/or password does not exist or is incorrect.
The time on the client machine differs too much from the real time (more than 24 hours).
The Online Backup Client cannot access the online services while port 443 (SSL) is blocked by a firewall on the network.
The next wizard page will ask you to set an encryption key. The purpose of this key is to encrypt all files before transferring them to the Backup Server and decrypt the files from the Backup Server when restoring them.
© BackupAgent 2012 Page 8 of 28
Online Backup Client User Manual
Figure 4: Encryption Key
You must type an encryption key and then confirm this key. You can only set the encryption key once. After setting the encryption key it cannot be changed. If you forget the encryption key, the data encrypted with this key cannot be accessed anymore. Please write down the encryption key in a safe place.
IMPORTANT: This key is unique and can only be chosen once and cannot be changed afterwards.
Treat this key with great care, since it is required to restore your files after a system crash.
Note: It is possible to store a reminder which can be sent to your personal email address. In this wizard the field to enter the reminder will change into a link: ‘Forgot your encryption key?’
The wizard is now finished.
Figure 5: End of Registration Wizard
© BackupAgent 2012 Page 9 of 28
Online Backup Client User Manual
5. Online Backup Client main interface
This is the main interface of the Online Backup Client. Several components are displayed in the figure below:
Navigation panel
Account Information
Main panel (e.g. Home)
Figure 6: Online Backup Client main interface
Navigation panel
The Navigation panel is the main navigation through the Online Backup Client. The options are:
Home:
Backup:
Start View
Select local data for a backup
Restore: Select remote data for a restore
Reports and Logs: View information on executed backups
Options:
Support:
About:
Configure backup tasks
View contact information for support
Additional information about the Online Backup Client
Account Information
Shows account details: account name, storage space, status and usage of storage space.
Main Panel
The main panel is the working space of the Online Backup Client. Depending on what you want to do, this panel will show the necessary views.
© BackupAgent 2012 Page 10 of 28
Online Backup Client User Manual
5.1 Home
When you start the Online Backup Client it will show the Online Backup Client Home view. This view shows the status of the last and the next backup task.
Figure 7: Status of the last and next backup
5.2 Online backup
You can create an online backup task by clicking on “Backup” in the "Navigation" panel.
Figure 8: Backup
5.2.1 Create or change backup task
To create or change a backup task:
Create task
Click on ‘New Task’ to create a new backup task.
© BackupAgent 2012 Page 11 of 28
Online Backup Client User Manual
The Task Properties will open, and you can configure: o General (change name of backup task) o Schedule o Pre/Post scripts o File System o MySQL
Change task
Select the task in the tree view, and click on ‘Edit Task’.
The Task Properties will open, and you can configure: o General (change name of backup task) o Schedule o Pre/Post scripts o File System o MySQL
5.2.2 General
The ‘General’ tab gives you a summary of the backup task. You can change the name of the backup task in this screen.
This is also the place where you can decide between an Online backup and an Offline backup.
Figure 9: General view
Task Name
You can give the backup task a name.
Online Backup
An online backup will be created to backup data to the backup service.
© BackupAgent 2012 Page 12 of 28
Online Backup Client User Manual
Offline Backup (local backup)
This is intended for the seed backup for a customer. This creates a .zip file which can be moved to the backup server and extracted there for the initial backup.
5.2.3 Schedule
You can set a schedule for the backup task in the ‘Schedule tab’ in the Task properties.
Figure 10: Set a schedule
The following schedule options are possible:
Never Performs a backup only if you manually start the task.
Once:
Daily:
Weekly:
Performs a backup once at the time that is inserted.
Performs a backup daily at the time that is inserted.
Use this option to select which time and day(s) the backup must be performed.
Monthly: Use this option to select which part of the month and day of the week the backup must be performed.
By checking ‘Active’, the backup task will be performed automatically on the scheduled times.
Note: If you select a task in the view “Backup”, and click on ‘Start task’, the backup task will be performed immediately.
5.2.4 Set Retention
Retention allows you to set the number of days your backup data will be kept before it is removed.
Data will be removed after set number of days in the following situations:
If an existing full backup is replaced by a new full backup
© BackupAgent 2012 Page 13 of 28
Online Backup Client User Manual
Example: A full backup takes place when data is backed up for the first time, or when the difference in data is more than 50%. If a new full backup is made, the old full backup will be automatically removed after the set number of days.
If the task is no longer active for that period of time
Example: If you set retention to 7 days and stop the OnlineBackupService or shut down your computer for that period of time, the backup data will be automatically removed. The retention time will only become active the second time you run the backup task.
If the data is no longer located at the original location
Example: If you made a backup of certain folder and you remove, rename or replace that folder on your computer, the backup of the folder will be deleted after set number of days.
You can also choose to not remove the selected backup data, in which case all backups of the data will be kept.
Note: When the task is set as an offline backup type (local backup), the option to set retention will be grayed out.
Note: The retention value is changed for all files in the task, no matter whether they still exist on the user’s computer or not.
5.2.5 Pre/Post-scripts
Pre-Script
A Pre-Script is an advanced option to run certain operations before starting the backup task. You can simply browse to a command or shell scripts (e.g. /home/script.sh) which will be executed prior to the start of the backup task.
Continue if Pre-Script fails
When checked, the backup will be performed, even if the pre-script did not run properly.
Post-Script
A Post-Script is an advanced option to run certain operations after a backup task has run. You can simply browse to a command or shell script (e.g. /home/script.sh) which will be executed after the backup task is completed.
User
This field indicates the user that is used to execute the script.
© BackupAgent 2012 Page 14 of 28
Online Backup Client User Manual
Figure 11: Pre/Post Scripts
5.2.6 File System
You can select data to backup in the ‘File System’ tab in the Task properties. You can easily expand and collapse the branches of the tree, by clicking the signs displayed at the left. All items are displayed with their type.
Figure 12: Select backup data
When a folder is selected for backup, underlying files and folders are automatically selected, unless explicitly deselected.
Note: If a folder is checked with a grey background only a subset of this folder is part of the backup set.
Note: A light grey square in front of a file or folder means that it is not possible to adopt that item in the backup set.
© BackupAgent 2012 Page 15 of 28
Online Backup Client User Manual
5.2.7 Filter
You can add file filters or folder filters that are excluded or included in the backup task. You can also choose to include hidden files by checking the checkbox.
Figure 13: The filter screen while making a backup
The various filter options are:
No file filtering (default)
Filter out files on file name/extension (‘Except specific files’)
Filter out all files except with certain file name/extension (‘Exclude all but specific files’)
Filter out folders by path pattern (e.g. Temp, Cookies, etc).
5.2.8 MySQL
Instead of a file backup you can select to make a MySQL backup.
Open the ‘MySQL-tab’ and you can see the MySQL backup plugin with the available servers and databases. Here you can select a database or even a table for the backup.
© BackupAgent 2012
Figure 14: MySQL backup plugin
Page 16 of 28
Online Backup Client User Manual
5.2.9 Backup progress
The backup process can be monitored by clicking on ‘Details’ at the bottom of the application during the process of a backup (the details screen will pop up automatically when a backup task is initiated).
Figure 15: The detail screen while making a backup
The details regarding the backup of data are:
Progress information
File progress:
Total progress:
The progress of the backup of the indicated file
The progress of the total backup task
In the table (the amount of files, the amount of selected MBs and the amount of sent MBs)
Full:
Patch:
NoNeed:
Skipped:
Done:
Total:
%Done:
Fully backed up files, which have not been backed up before
Patched backed up files (incremental backups)
Unchanged files (unchanged compared to the last backup)
Skipped files (details in the logs (explained later))
The total amount of processed data
The total amount of selected data
The percentage of processed data
Other information
Avg.upl.speed:
Remaining time:
Elapsed time:
The average upload speed
The estimated remaining time
The elapsed time
Compression: The average compression rate of the backed up data
Size uploaded: The size of the uploaded data
Total size: The total size of the selected data
5.3 Offline backup
You can create an offline backup task by clicking on ‘Backup’ in the ‘Navigation’ panel.
© BackupAgent 2012 Page 17 of 28
Online Backup Client User Manual
Task Name
You can give the backup task a name.
Backup type
Set the backup type to ‘Offline backup’ and click on ‘Browse’ to select the storage location.
Here you can also decide whether to create a Zip archive or not.
A zip archive is smaller to save, but you do have to unzip the files on the backup server when this is an initial offline backup.
All the next steps are the same as for an Online backup.
5.3.1 General
The ‘General’ tab gives you a summary of the backup task. You can change the name of the backup task in this screen.
This is also the place where you can decide between an Online and an Offline backup.
Figure 16: General view
Task Name
You can give the backup task a name.
Backup type
Set the backup type to ‘Offline backup’ and click on ‘Browse’ to select the storage location.
Here you can also decide whether to create a Zip archive or not.
A zip archive is smaller to save, but you do have to unzip the files on the backup server when this is an initial offline backup.
All the next steps are the same as for an Online backup.
© BackupAgent 2012 Page 18 of 28
Online Backup Client User Manual
5.4 Restore
Your backed up data can be accessed by clicking “Restore” in the "Navigation" panel.
5.4.1 View backed up data
This view shows a collection of computers in the tree view. These computers are the base of the backup schedules. If the Online Backup Client is (or was previously) installed on a computer, this computer will be shown in this screen. Furthermore, the tree view shows all backed up data in the same structure as it was on your computer. In this view you can restore or delete data from the
Backup Server. You are also able to import a local backup for restore.
Figure 17: Restore
5.4.2 Restore latest versions of data
Data can be restored per file, folder or drive. Select files, folders or drives you want to restore, in the node tree. By clicking the 'Restore’ button, the latest version of the data will be restored automatically.
This is the most common option.
© BackupAgent 2012 Page 19 of 28
Online Backup Client User Manual
Figure 18: Restore screen
Before the restore starts, the client will ask you where you want to store the restored data. You can choose between the Default Location, the Original Location or an Alternative Location.
Note: If a file already exists on the restore location, a prompt appears that allows you to skip, rename or overwrite the file.
5.4.3 Restoring older versions of data
When a file has been changed within the period between two backups, the client will backup the file and notice that it has changed. The Online Backup Client will then create multiple versions of the file depending on the retention value you set.
Restore at date
It is possible to restore a file or folder from a selected date in the past. You select a file or folder in the ‘Restore’ view and click on ‘Restore’ in the lower main panel. In the ‘Restore’ view that appears, click on the ‘Versions before date’ button. Here you can select a date. The latest backed up versions of the selected files or folder before that date will be restored.
5.4.4 Restore process
The restore process can be monitored by clicking on ‘Details’ on the bottom of the application during the process of a restore (the details screen will pop-up automatically when a restore is initiated).
© BackupAgent 2012 Page 20 of 28
Online Backup Client User Manual
Figure 19: Restoring Data
The details regarding the restore of data:
Progress information
Status:
Current file:
File progress:
Total progress:
The status of the restore
The file that is being restored at the time
The progress of the restore of the indicated file
The progress of files that have been restored
Compression:
Size downloaded:
The average compression rate of the backed up data
The size of the downloaded data
5.4.5 Deleting data from Backup Server
To delete data from the Backup Server, click on "Restore" in the "Navigation" panel. Select the data that needs to be deleted by checking the checkboxes (you can select multiple files or folders). Click on the "Delete" button in the lower main panel to delete the file(s). The client will ask you to confirm the delete action.
Figure 20: Confirm delete action
Note: You can choose to delete all data except the latest versions. This can be useful to clean up your backup account.
© BackupAgent 2012 Page 21 of 28
Online Backup Client User Manual
5.4.6 Reset Retention
Within the Restore view it is also possible to reset the retention per file, per folder or per computer.
Note that resetting retention will count for all subfolders, files and versions within those folders.
5.5 Options
You can set different kinds of settings by clicking “Options” in the "Navigation" panel.
Figure 21: Options
5.5.1 General
In the “General”-tab, you can set general options of the Online Backup Client:
You can change the language of the application
You can enable or disable the sending of backup and restore reports by email
You can enable or disable to always install an update when it is available
You can change the password for your backup account
Note: It might not be possible to change your password in the Online Backup Client, since your
Online Backup Provider can disable this option
Note: It is not possible to change the username or encryption key.
© BackupAgent 2012 Page 22 of 28
Online Backup Client User Manual
5.5.2 Backup and Restore
In the “Backup and Restore”-tab, you can set options that are specific for backing up and restoring with the Online Backup Client:
Figure 22: Default restore directory
Data Retention
In this view you can set the default data retention value. By default this is 30 days. This default value will be used when creating new backup tasks.
Restoring
In this view the default restore folder can be specified. This is the folder where data is restored by default when you don’t choose a specified folder.
Restoring
You can enable or disable to always calculate the restore size.
5.5.3 Advanced
In the “Advanced” tab, you can set advanced options of the Online Backup Client:
You can set the type of Encryption of the data that will be backed up: AES 128 bits or 256 bits encryption. By default only AES 128 bits is available, but AES 256 bits can be enabled via a special file download.
Timeout for the service request setting:
80 is the timeout for the socket layer. Further retries will be performed with the following delays: 5, 10, 20, 40 sec.
© BackupAgent 2012 Page 23 of 28
Online Backup Client User Manual
Logging: Here you can set the directory where you can save the log files. You can also enable ‘Detailed logging’ in case of problems. You will be asked to enable this by support in case of problems.
Figure 23: Advanced settings
5.5.4 Plugins
In the “Plugins” tab, you can set the options for all available plugins.
5.6 MySQL backup
Within the “Plugins” tab you can activate the MySQL backup plugin. Once you have this activated you can set the plugin options like the URL, username and password. This plugin can be used to backup local or remote MySQL databases.
© BackupAgent 2012 Page 24 of 28
Online Backup Client User Manual
Figure 24: MySQL backup plugin
Figure 25: MySQL plugin Options
5.7 Report details
Click on “Reports and Logs” in the "Navigation" panel for a chronological overview of important events.
5.7.1 Reports
The “Reports” view shows a history of reports. You can view the status of past backups and restores:
© BackupAgent 2012 Page 25 of 28
Online Backup Client User Manual
Figure 26: Report view
Double-clicking on a report will show report details:
Figure 27: Report details
This report will also be sent to you by email.
It is possible to clean the reports or logs list. In the list of reports or logs, click on the ‘Delete selection’ button.
© BackupAgent 2012 Page 26 of 28
Online Backup Client User Manual
5.7.2 Logs
The ‘Logs’ view shows a history of log files:
Figure 28: Log view
Three types of events can occur:
Information:
Warning:
Error:
Information on the progress of the backup or restore procedure.
Non fatal errors occurred during backup or restore process.
A fatal error has occurred in the Online Backup Client.
Details of the log message can be viewed by clicking on ‘View’. This shows a dialog with detailed information of the message.
© BackupAgent 2012
Figure 29: Log Event Details
Page 27 of 28
Online Backup Client User Manual
5.8 Support
Clicking on “Support” in the "Navigation" panel will give contact details of your Online Backup
Provider.
Figure 30: Support contact information
5.9 About
Clicking on “About” in the "Navigation" panel will give details about the version of the software and the license of the software.
© BackupAgent 2012
Figure 31: Online Backup Client about
Page 28 of 28
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Related manuals
advertisement