Syncrify » Administrator's Guide

Syncrify Client


Syncrify client is used to backup files from a client machine to Syncrify server using HTTP(S) protocol. The version of Syncrify client is tied to Syncrify server. We recommend you use the same version and build number for both Syncrify client and server.

Downloading Syncrify Client

Follow the steps below to download Syncrify Client.
  • Connect to Syncrify Server machine using a web browser on the client machine
  • Click Download client under Quick Links on the right hand side. See screenshot

Modes of Operation

Syncrify client can be run in two modes:
  1. GUI - recommended for users on Microsoft Windows and Mac OS X
  2. Console - recommended for users on Linux, UNIX and BSD

GUI Client
On Windows operating system, click the Syncrify Client icons from the Programs menu.

On Mac, double click the icon for SyncrifyClient.app

To run GUI client on Linux and UNIX type the following command in the Terminal window

/opt/Syncrify/SyncrifyClient.sh
This refers to the script that launches Syncrify Client in GUI mode.
IMPORTANT: You must have X-Windows installed on Linux/Unix to use Syncrify client in GUI mode.


Following image shows Syncrify client running on Microsoft Windows.


Console

Using Syncrify client from command line

When using Syncrify client on platforms other than Windows, it may be convenient to use the command line interface to run your backup instead of using the GUI interface. If you are connecting to a Linux/UNIX machine remotely using SSH, you may not have a choice of using the GUI client. In such cases, you don't have a choice but to use the command line interface.

This section demonstrates how to use the command line interface.

Prerequisites

  • Java run-time must be installed on the machine. If you downloaded Syncrify Client with installer, check $INTSTALL_DIR/jre/bin/java to ensure a file exists. Otherwise, download java from http://java.com
  • Either java must be on your machine path or use the absolute path to run java

Downloading Client

Download Syncrify Client for Linux from here. The installation copies necessary files to /opt/SyncrifyClient by default. This path is referred as $INSTALL_DIR below.

You will need SyncrifyClient.jar in order to create profiles and follow instructions on this page. However, this file is not present in the $INSTALL_DIR. Copy $INSTALL_DIR/clientRT.tmpl to SyncrifyClient.jar to get this file.

Command line usage

java -jar SyncrifyClient.jar -console ProfileName.syncrify Preferred method

OR

java -jar SyncrifyClient.jar -console [OtherOptions] [SourceFile/Folder] [TargetURL] Deprecated method 

Options

Most options are in a name-value format, except for the stand-alone parameters. The parameter name starts with a minus (-) sign followed by its name, a space and then its value. For example:

-pr ProfileOne

Option Description
-console This option makes Syncrify client run in console mode. If this is missing every other option will be ignore and Syncrify client will run in its default GUI mode
-u User's email address that is used to identity the account on the server.
-p User's password
-pr Profile name corresponding to the Profile name on the server. Use the same value for profile name when running the same backup again. Specifying a different value will cause the server to store files in a different folder. This can be a one-word value without spaces and should contains characters that are considered valid for a directory name.
-sp Server path. This corresponds to a one-word folder name on the server that is used for storing files under the profile. Use the same value for this parameter when running the same backup again. This can be a one-word value without spaces and should contains characters that are considered valid for a directory name.
-sF Selected Folder. Specifies one folder location that you want to backup or restore. This parameter must be accompanied by -tF
-tF Top Level Folder. Specifies the top-level folder where the selected folder is located. This parameter must be accompanied by -sF. The -sF and -tF parameters are only valid if you are running backup/restore on an existing profile and just want to run a backup on a specific folder. This is equivalent of backing up a selected folder specified here using console.

Refer to example 2 below.
-enableVersioning This is a stand-alone parameter. Enables versioning.
-twoway This is a stand-alone parameter. Enables Two-way sync.
-saveProfile This is a stand-alone parameter. This is a convinient way of creating a profile file without running the actual backup. The profile file will be created in ~/.syncrify folder. Refer to example number 2 below to see how to use this profile to run backup.
-nocompression This is a stand-alone parameter. When present Syncrify client won't use compression before transferring files.
-skipRedir By default, messages sent to STDOUT and STDERR are sent to files in the $DATA_FOLDER\logs directory. Use -skipRedir to send console messages to screen instead of redirecting them to files.
-v This is a stand-alone parameter. When present log messages will appear on the console.

Examples

An important information to keep in mind is the use of -console parameter. When this parameter is missing, Syncrify will display a GUI window showing a status bar. -console parameter is very useful when you do not have the GUI interface available, which is typically the case on Linux and Unix machines.

Example 1

Use the following example to run a backup based on a pre-created profile file. This is the preferred method of running backup.
java -jar SyncrifyClient.jar -console  myProfile.syncrify
The above example assume you have a pre-created profile called myProfile and want to run it through command line.

Example 2

Use the following example to run a backup based on a pre-created profile file. This is the preferred method of running backup.
java -jar SyncrifyClient.jar -console  myProfile.syncrify -tF /user/home/jack/Desktop -sF /user/home/jack/Desktop/Pictures/NewYork
This example runs a profile called myProfile and will only backup files in /user/home/jack/Desktop/Pictures/NewYork folder.

Example 3

Use the following example to run a backup based on a pre-created profile file and use a specific folder for TEMP.
java -Djava.io.tmpdir=/opt/ATempFolder -jar SyncrifyClient.jar -console  myProfile.syncrify
The above example a backup is run against myProfile and the client will use /opt/ATempFolder to store temporary files.

Example 4 (deprecated)

java -jar SyncrifyClient.jar -console  -v -u jack@company.com -p secret -pr firstProfile -sp t2 -nocompression /user/home/jack/Desktop https://backup.company.com
In the above example, files located in \user\home\jack\Desktop will be backed up to a server running on backup.company.com using the HTTPS protocol on default port. No compression will be used.

IMPORTANT NOTE: This example is deprecated and does not provide every backup option and therefore, we recommend you use the first example.

Capturing Exit Codes

Often users want to capture the exit code returned by Syncrify, which is useful if you are running Syncrify client from a script and want to know if it ran successfully. Syncrify returns the following exit code when it is run in console mode.
0
Unknown error - Syncrify client will never return a 0
1
Backup ran successfully
2
Backup ran with errors
3
Backup did not run at all
100
Invalid parameters
Note:
Exit codes are only returned when running Syncrify client in console mode. They are not returned by BackupClient.exe file on Windows.

Creating profile from console

You can create a new profile using the following command from console:
java -jar SyncrifyClient.jar -console -createProfile


This will prompt you for the following questions.

Profile name: Name of the profile. We recommend you use a one-word name without spaces. Assume you use MyBackup for this value, you can issue the following command to run a backup

java -jar SyncrifyClient.jar MyBackup.syncrify
Server URL: Refers to the URL where your server is running. For example:

http://backup.YourCompany.com:5800 OR
https://backup.YourCompany.com
Login email: Email address used for user's login
Password: User's password
Path: Refers to the path that you want to backup. For example:

/users/home/john/Documents
Filter Specify a filter string. Refer to this document for more information
Additional path: Specify additional folders/files to backup. You can specify as many paths as you like. Hit ENTER without typing any path when done.
Excluded path: Enter path that you want to exclude from the list
Compress data: Type Y for yes and N for no. When set to Y, client will compress data before sending it to the server
Delete files: Type Y for yes and N for no. When set to Y, server will delete files if they are deleted from the client.
Backup locked files Type Y for yes and N for no. When set to Y, VSS services are used on Windows. This parameter is only meaningful on Windows. It has no affect on other operating systems.
Enable versioning Versioning is enabled if set to Y
Send email: An email is sent with a backup log
Email recipient Address that gets the email. If blank, login email is used for the recipient's address
Encryption key Password used for encryption


Concept of profiles

A profile defines a set of files/folders that are grouped together for backup. When Syncrify client is first used on any client, it automatically creates a profile and gives it a name that matches the machine's host name.

Typically, you would only need one profile per machine for a user. However, if you wish to backup certain files at a different schedule, you might want to create additional profiles.

To add files/folders to a profile, drag the desired folder from Explorer to left hand panel. You could also click the right mouse button an select Add a file or folder from the pop-up menu. There is no limit on the number of files you add to a profile.

By default every file in a folder is selected for backup. To exclude, navigate to the desired file and un-check its name.

Specifying backup parameters

Following parameters must be specified before a backup is performed.
  • Specify files to backup. This is done by either dragging a file from Windows Explorer to the left hand side of the screen or by clicking the right mouse button and selecting Add a folder/file menu item.

  • Current Profile Name - this automatically populated and contains the name of the profile currently selected

  • Remote Server URL - this should contain the URL for the Syncrify server. If the server is listening on port other than 80, that value must be specified following a colon. Following are some examples of a valid URL:

  • NOTE: Replace these URLS with the machine IP that is running Syncrify Server

    • http://192.168.1.20 - This assumes server is listening on port 80
    • http://192.168.1.20:5800 - This assumes server is listening on port 5800
    • http://backup - Referring by server's host name. Ensure you are able to ping the server by its name before using this value. In this case server is listening on port 80.
    • http://files.yourCompany.com - This uses the fully qualified name of the server. Ensure you are able to ping the server by its name.
    • https://backup.yourCompany.com - This uses HTTPS as the protocol and uses a fully qualified domain name for the server.

  • Login Email - This is the email address used for the user on Syncrify server.

  • Login Password - This is the password for the user.

  • Remote Server Path - This is a system assigned value that is used on the server's end to store files. Most likely you will not have to modify this value and leave it the way it is.

  • Advanced Options - To access the Advanced options, click the Advanced tab. Refer to the image below.

    • Delete files from server - when checked, Syncrify will delete file from the server if the corresponding file is deleted on the client. When this is not checked, a copy will remain on the server.

    • Send notification email - Check this box if you want Syncrify client to generate an email when a backup is completed. The box next to the check box is used to specify the recipient(s) of the email report. When this box is left blank, the login ID is used as the recipient address. Use a comma to separate multiple addresses.

      This email is only sent when a scheduled backup is run. Email is not generated when a user manually runs a backup.

    • Compress data - when checked, smart compression is used to before sending the data over the network. During the backup if no significant size reduction is gained by compressing a file, data gets sent as-is. Consider a scenario where you have large files containing a relational database, which can be significantly reduced in size by using compression. On the other hand, files like MP3, JPG do not reduce in size when compression is applied. In such cases, the compression step is eliminated saving CPU cycles on both client and server.

    • Enable versioning - when checked, multiple versions of every file are stored on the server. The number of older versions maintained on the server is defined by the administrator who is managing Syncrify server. A version is only created if a user modifies a file. Click here to read more about versioning.

  • Encryption - Use this tab to enable encryption and specify a password. Refer to this document before using encryption during backup.

Running backup manually

To run a backup on demand, simply click the Backup button

Running backups from command line

Before you can run backups from command line, you have to create a Profile using the GUI. Every profile you create is stored in user's home directory with a file extension of .syncrify

On Windows you can run a backup by specifying the Profile file name as a command line argument to SyncrifyClient.exe file. For example:

C:\Program Files\SyncrifyClient\SyncrifyClient.exe MyProfile.syncrify

In the above example, MyProfile is the profile name of the profile you want to backup.

On Linux and other platforms, you should be able to execute a backup by using the following command line:

SyncrifyClient.sh MyProfile.syncrify


Scheduling a backup on MS Windows

On Windows, the scheduler for Syncrify is integrated with the operating system. Every Windows machine comes with a scheduler that is used to schedule backup tasks on the client machine.

Following steps demonstrate how to schedule a backup.
  • Click Add button to add a new schedule
  • This opens up the Scheduler window.



  • Click the Schedule tab to specify a schedule



  • Finally, click Ok. Windows will prompt you for a user id and password. Specify a valid user id and password on your system. Backup task will be run using this login. We recommend using the same ID that owns the files that are being backed up.




  • Finally, Click Ok




Scheduling a backup on Mac OS X

Scheduling a backup task on Mac is similar to Windows but it uses the built-in scheduler that comes OS X.

Following steps demonstrate how to schedule a backup on Mac.
  • Click the Add button at create a new schedule.

  • This opens up the scheduler windows, which looks like the image below

  • This window allow users to select the weekday and a time of the day to run the backup task. Notice that hour are represented in 24 hour time format - meaning if you want to schedule a task at 8:30 PM, you will have to select 20 for hour and 30 for minutes.
  • You should also specify a time interval to run backup. This allows you to run the backup task after every X number of minutes. For example, to run a backup every 5 hours, specify 300 minutes. See below.



Restoring files

File restoration is accomplished either by a web browser or using the Syncrify client.

Using web browser
Using a web browser connect to Syncrify Server. The URL in the address bar must be exactly what you typed in the Remote Server URL when specifying backup parameters. Use your email and password to login. Once logged in, you will be displayed a remote file explorer containing files that are backed up on the server. Simply navigate to the file you want to restore and double click it to download.

Restoring encrypted files
When encryption is used, files residing on the server cannot be viewed or opened by anyone. Therefore, when you use a web-browser to download any file, they need to be decrypted manually once they have been downloaded. If you try to open the downloaded file without decrypting it first, you will get errors in the program that is trying to open it.

Use the following steps to decrypt files:
  • Download encrypted file(s) using your browser
  • Start Syncrify client on the machine
  • Click Encrypt/Decrypt files from the Tools menu
  • Select Decrypt for Conversion type
  • Specify the password you used for encryption
  • Select the desired file
  • Finally, click Start Processing



Using Syncrify client

You can either restore the entire profile or selectively pick the file(s) you want to restore. The client program automatically handles decrypting files if they were backed up using encryption.

Restoring entire profile


Follow the steps below to restore entire profile
  • Select the profile you want to restore. If you do not have the profile on this machine, try creating a new profile with the same name. Profile names are case-sensitive. When a new profile is created, it won't contain any folders on the left hand side. This is okay. Refer to the image below.



  • Next, click the Restore button
  • Syncrify client will first pull the profile from the server matching the name. If it is not able to pull a profile, ensure the profile name is correct.

    Once the profile is download, it will start restoring the files.


Restoring selective files



Selective files can only be restored if the profile exist on your machine. Follow the steps below to restore files using Syncrify client
  • Chose the appropriate profile from Available Profile list on the top
  • Navigate to the file you want to restore on the left hand side
  • Click the right mouse button and select Restore selected file
Refer to the image below.





Restoring one folder

Use the following steps to restore a folder
  • Start Syncrify client
  • Select a desired profile
  • Navigate to a folder you would like to restore
  • Click the right mouse button to bring up a pop-up menu
  • Select Restore → Selected folder

Navigation

Social Media

Powered by 10MinutesWeb.com