ironsync real-time file sync server

7/31/2019 IronSync Real-Time File Sync Server

1/16

IronSync Real-Time File Synchronization Flexense Ltd.

1

User Manual

Version 1.5

Jun 2012

Flexense Ltd.www.flexense.com

www.ironsync.com

IronSyncReal-Time Sync


2/16


2

Product Overview

IronSync Server is a real-time file synchronization server capable of synchronizing multiplepairs of local disks, directories and/or network shares. IronSync Server monitors file systemchanges and performs file synchronization operations in real-time as files on the disk arechanging without scanning directories thus allowing one to effectively synchronize huge file

systems containing millions of files.

IronSync is optimized for modern hardware architectures and is capable of effectively utilizing

multi-core CPUs and multi-CPU servers while synchronizing millions of files in real-time. Onthe other hand, IronSync Server is especially designed to run on production servers using a

very small amount of the system memory (6MB-8MB) and CPU resources in order to minimizethe performance impact on running production applications.

IronSync Server runs as a service in the background and provides a web-based managementinterface allowing one to control, configure and manage the product using a regular web

browser locally or through the network. The user is provided with the ability to setup multiple

file synchronization commands, optionally specify exclude directories and/or specific types offiles to synchronize, customize error recovery options, enable error logs and/or send E-Mailnotifications when a sync command fails due to a hardware problem.


3/16


3

Product Installation Procedure

IronSync Server is especially designed to be as simple as possible. The product does notrequire any third-party software applications and may be installed and configured within acouple of minutes. A fully functional 30-days trial version of IronSync Server may bedownloaded from the following page: http://www.ironsync.com/downloads.html.

The installation package is very small, 2MB - 3MB depending on the target operating system,and the product requires just 10MB of the free disk space on the target server. In order toinstall IronSync Server, start the setup program, select a destination directory and press the'Next' button.

Optionally, enter custom server control and/or web access ports. The server control port isused by the IronSync command line utility to connect to the server and the web access port isthe port for the web-based management interface allowing one to control IronSync Server

using a standard web browser. If IronSync Server should be controlled remotely through thenetwork, make sure one or both of these ports are open in the server's firewall.


4/16


4

Web-Based Interface

IronSync Server provides a complete web-based management interface, which allows one tofully control, manage and configure one or more IronSync servers locally or though thenetwork using a standard Web browser. By default, the web-based interface uses the TCP/IPport 80, which is the default HTTP port web browsers are using to connect to a web server.

In order to connect to IronSync Server, open a regular web browser, enter the host name ofthe server to connect to and login using the default user name and password: admin/admin.

The IronSync web-based interface is a dynamic web application, which shows the currentstatus of the server and the progress of performed operations without reloading the currentlydisplayed web page. In order to operate properly, the web-based interface requires JavaScriptto be enabled in the web browser.


5/16


5

Managing File Synchronization Commands

IronSync Server allows one to setup an unlimited number of file synchronization commandswith each one synchronizing files from a source disk or directory to a destination disk ordirectory. In order to setup one or more file synchronization commands, login to the IronSyncServer web-based management console using a standard web browser.

On the IronSync Server status page, press the 'Add Command' button, enter a uniquecommand name, enter a source directory, which should be a local disk or directory, and entera destination directory, which may be set to a local disk, directory or a network share, andpress the 'Save' button.

In order to start a file synchronization command, go to the main status page and click on the'Start' button located on the right side of the file synchronization command. Click on thecommand name link to see an extended status of the command. In order to stop an active filesynchronization command, click on the 'Stop' link located on the right side of the filesynchronization command.


6/16


6

Advanced Command Options

In order to access advanced file synchronization command options, click on the 'EditCommand' button located on the right side of the file synchronization command and press the'Advanced Options' button. The advanced options page allows one to specify one or moreexclude directories, set the number of file synchronization streams to use for the command,

setup a custom error logs directory to save error reports and/or send E-Mail notifications whenthe command is aborted due to a hardware problem.

Another very useful feature is the sync preview mode, which may be enabled for any filesynchronization command on the advanced options page. In the preview mode, IronSync willmonitor the source directory, examine all detected file system changes and calculate theexpected change rate without performing any actions in the destination directory. This modeallows one to analyze a frequently changing file system and estimate expected performancerequirements in order to properly select a fast enough backup device to be used as adestination directory for a file synchronization command.

IronSync Server provides the ability to perform initial file synchronization for static filesexisted in the source directory before the file synchronization command was started for thefirst time. In order to enable initial file synchronization for a sync command, open the maincommand page and select the 'Enable Initial File Synchronization' option. By default, initial file

synchronization is performed when the IronSync server is idle, paused when a large number ofreal-time sync actions should be performed and automatically resumed when the number ofpending sync actions drops below a user-configurable limit.

The 'Initial Sync Start Limit' option sets the number of pending file system changes or pendingsync actions triggering the start of the initial file synchronization operation. The 'Initial SyncStop Limit' option sets the number of pending file system changes or pending sync actionstriggering the stop of the initial file synchronization operation. For example, when the number

of pending sync actions drops below the start limit, the initial file sync operation is resumedand when the number of pending actions raises above the stop limit, the initial sync operationis paused.


7/16


7

File Matching Rules

Sometimes, it may be required to synchronize files related to a specific file type or categoryaccording to user-specific needs while skipping all other files. IronSync Server allows one tospecify which types of files should be synchronized by a file synchronization command. Theuser is provided with the ability to synchronize files by the file name, extension, directory, file

type, size, text or binary patterns, etc.

For example, IronSync Server allows one configure a file synchronization command to sync alltypes of images with the file size more than 10 MB and the file name not beginning with'IRONSYNC' while skipping all other files not matching the specified rules. In order to configure

file matching rules for a command, open the command page and press the 'Rules' button. Onthe 'Rules' page press the 'Add Rule' button, select an appropriate rule type, operator, a rulevalue and press the 'Save' button.

IronSync Server allows one to add an unlimited number of file matching rules for each file

synchronization command with each one configured to match files by a specific file property.

In addition, advanced users are provided with the ability configure an unlimited number ofhierarchical nested rules combined with logical operators and allowing one to precisely selecttypes of files that should be synchronized.


8/16


8

File Synchronization Options

Additional file synchronization options may be controlled on the 'File Sync Options' page. Inorder to open the file synchronization options page open the file synchronization commandpage and press the 'Options' button.

Sync File Attributes - select this option if you wish to sync file attributes for all filescopied from the source to the destination directory (by default this option is enabled).

Sync User/Group Security Descriptor - select this option if you wish to copy fileownership information for all files copied from the source to the destination directory(by default this option is disabled).

Sync Discretionary Access Control Lists (DACL) - select this option if you wish tocopy DACLs for all files copied from the source to the destination directory (by default

this option is disabled). Sync System Access Control List (SACL) - select this option if you wish to copy

SACLs for all files copied from the source to the destination directory (by default thisoption is disabled).

Skip System Files and Directories - select this option if you wish to skip all systemfiles and directories from the file synchronization process (by default this option isenabled).

Skip Hidden Files and Directories - select this option if you wish to skip all hiddenfiles and directories from the file synchronization process (by default this option isenabled).

Bit-Level File Synchronization - select this option if you wish to copy only changeddata blocks for files that should be synchronized (by default this option is disabled).

Verify Files After Copy - select this option if you wish to verify each file copied tothe destination directory (by default this option is disabled).

* All security related options require administrative privileges and the IronSync service needsto be configured to run under a user account having enough permissions to access all therequired network shares and perform DACL and SACL copy operations.


9/16


9

Using IronSync to Synchronize Network Shares

By default, the IronSync service is configured to run under the local system account, which isgood to synchronize local disks and directories. On the other hand, the local system accountdoes not have permissions to access network shares and NAS storage devices.

In order to enable IronSync Server to synchronize files to network shares and NAS storagedevices, the IronSync service should be configured to run under a user account, which haspermissions to create files and directories on the required network shares.

The configuration is very simple and may be performed within a couple of seconds using thefollowing step-by-step guide:

1. Open the Windows control panel and click on the 'Administrative Tools' utility.

2. Open the Services control center and find the 'IronSync Server' service.3. Open the 'IronSync Server' service, select the 'General' tab and stop the service.4. Select the 'Log On' tab and specify a user account to use for the IronSync service.5. Select the 'General' tab and start the 'IronSync Server' service.

Now, the IronSync service will run under the specified user account and will have exactly the

same permissions as the specified account when accessing network shares and NAS storagedevices.


10/16


10

Configuring IronSync Server

IronSync Server provides a variety of configuration options allowing one to easily integrate theproduct into a user-specific network environment. In order to open the main settings page,click on the 'Settings' link located on the top menu bar.

Configuring User Name and Password

The IronSync Server web-based management console, requires users to login with a IronSyncuser name and password. The default user name and password is set to: admin/admin. Inaddition, IronSync Server provides the ability to set a custom user name and/or password forthe IronSync web-based management interface and the command line utility, which may beused to automate configuration and management tasks.

In order to set a custom user name and password, click on the 'Configure Server Login' linklocated on the main settings page, enter a new user name and password and press the 'Save'button.


11/16


12/16


12

Configuring Server Control and Web Access Ports

IronSync Server uses the TCP/IP port 9142 as the default server control port and the TCP/IPport 80 as the default web access port. Sometimes, these ports may be in use by some othersoftware products or system services. If one or both of these ports are in use, IronSync will beunable to operate properly and the user needs to change the IronSync server control port

and/or web access port.

In order to set a custom server control port and/or web access port, click on the 'Setup ServerPorts' link located on the main settings page, select the 'Use Custom Port' option and enter acustom port number to use. If the IronSync server should be controlled through the network,make sure the custom ports are open in the server's firewall.

Configuring E-Mail Notifications

IronSync Server provides the ability to send E-Mail notifications when a file synchronizationcommand fails due to a hardware problem. In order to configure an SMTP E-Mail server to use

to send E-Mail notifications, click on the 'Configure E-Mail Server' link located on the mainsettings page, enter the SMTP server host name, SMTP server port, SMTP user name,password and the source E-Mail address to use to send E-Mail notifications.


13/16


13

Command Line Utility

In addition to the web-based management interface, IronSync Server provides a commandline utility, which may be used to control, manage and configure one or more IronSyncServers locally or through the network. By default, the IronSync command line utility islocated in the '\bin' directory.

The command line utility may be executed with a variety of command line parameters andoptions allowing one to automate control, configuration and management of one or moreIronSync Servers using batch files or shell scripts. For detailed information about availablecommand line options, execute the command line utility with the '-help' command lineparameter.


14/16


14

Product Update Procedure

Flexense develops IronSync Server using a fast release cycle with minor product versions,updates and bug fixes released almost every month and major product versions releasedevery year. New product versions and product updates are published on the product web siteand may be downloaded from the following page: http://www.ironsync.com/downloads.html.

Due to the fact that the product is especially designed for servers running in productionenvironments where stability is a major decision factor, IronSync Server updates should bemanually performed by the user. In order to update an existing product installation, download

the latest product version and just start the setup program.

The IronSync Server setup program will properly shutdown the running IronSync Server,update the product and restart the IronSync service after finishing the update procedure. Allproduct configuration files, configured file synchronization commands and product registrationwill remain valid and there is nothing to reconfigure or manage after the update.


15/16


15

Product Registration Procedure

Within a couple of hours after purchasing a product license, the customer will receive two e-mail messages: the first one confirming the payment and the second one containing an unlockkey, which should be used to register the product. If you will not receive your unlock keywithin 24 hours, please check your spam box and if the unlock key is not in the spam box

contact our support team: [email protected].

If the computer where IronSync Server is installed on is connected to the Internet, login to theIronSync web-based management interface (default user name and password: admin/admin)

using a standard web browser, click on the 'About' link located on the top menu bar, press the'Register' button, enter your name or your company name, enter the received unlock key andpress the 'Register' button.

If the computer is not connected to the Internet, press the 'Manual Registration' button,

export the product ID file and send the product ID file to [email protected] as anattachment. Within a couple of hours, you will receive an unlock file, which should be importedin order to finish the registration procedure.


16/16


16

Supported Operating Systems

IronSync Server System Requirements

32-Bit Operating Systems

Windows XP Windows Vista Windows 7 Windows Server 2003 Windows Server 2008 Windows Storage Server 2008

64-Bit Operating Systems

Windows XP 64-Bit Windows Vista 64-Bit Windows 7 64-Bit Windows Server 2003 64-Bit Windows Server 2008 64-Bit Windows Storage Server 64-Bit

Minimal System Configuration

Supported Operating System 500 MHz or better CPU 256 MB of system memory 25 MB of free disk space

Recommended System Configuration

Supported Operating System 2 GHz or better CPU 512 MB of system memory 25 MB of free disk space

ironsync real-time file sync server

Documents