IronSync File Synchronization Server. IronSync FILE SYNC SERVER. User Manual. Version 2.6. May Flexense Ltd.

Transcription

1 IronSync FILE SYNC SERVER User Manual Version 2.6 May

2 1 Product Overview Product Installation Procedure Using IronSync Client GUI Application Types of File Synchronization Commands Periodic File Synchronization Commands Periodic File Synchronization Triggers Server-To-Server File Synchronization Commands Real-Time File Synchronization Commands Real-Time Directory Synchronization Commands Advanced File Synchronization Options Synchronizing Specific Types of Files Excluding Directories From File Synchronization File Synchronization Logs and Error Notifications Connecting to IronSync Server Through the Network Using IronSync to Synchronize Network Shares Configuring IronSync Server Product Update Procedure Product Registration Procedure Using Web-Based Interface File Synchronization Command Types Managing File Synchronization Commands Periodic File Synchronization Commands Real-Time Directory Synchronization Commands Advanced File Synchronization Commands Options Synchronizing Specific Types of Files File Synchronization Options Excluding Directories From File Synchronization Configuring IronSync Server Configuring User Name and Password Configuring Error Handling Options Configuring Server Control and Web Access Ports Configuring Notifications Product Registration Procedure OEM Product Version Using IronSync Command Line Utility Supported Operating Systems System Requirements

3 1 Product Overview IronSync Server is a powerful file synchronization solution providing multiple types of periodic, server-to-server and real-time file synchronization operations. IronSync is a highly scalable file synchronization solution especially designed to effectively synchronize huge file systems containing tens of millions of files. Users are provided with multiple one-way and two-way file synchronization modes, periodic and real-time file synchronization capabilities, compressed and encrypted file synchronization capabilities, file synchronization logs, notifications, file synchronization statistics reports, etc. 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. On the 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 minimize the performance impact on running production applications. IronSync Server runs as a service in the background and provides a client GUI application, a command line utility and a web-based management interface allowing one to control, configure and manage one or more IronSync Servers locally or through the network. The user is provided with the ability to setup multiple file synchronization commands, specify exclude directories, synchronize specific types of files, customize error recovery options, enable error logs and/or send notifications when a sync command fails due to a hardware problem. 3

4 2 Product Installation Procedure IronSync Server is especially designed to be as simple as possible. The product does not require any third-party software applications and may be installed and configured within a couple of minutes. A fully functional 30-days trial version of IronSync Server may be downloaded on the following page: The installation package is very small, 6MB - 7MB depending on the target operating system, and the product requires just 20MB of the free disk space on the target server. In order to install 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 is used by the IronSync client GUI application and the command line utility to connect to the server and the web access port is the 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 the network, make sure one or both of these ports are open in the server's firewall. 4

5 3 Using IronSync Client GUI Application The IronSync Server client GUI application provides the ability to configure and control file synchronization commands, setup periodic file synchronization operations, customize file synchronization logs and error handing options. The client GUI application may be used to control one or more IronSync Servers locally or via the network. The IronSync client GUI application shows the status of configured file synchronization operations in the top view and the IronSync Server message log in the bottom view. In order to add a file synchronization command, press the 'Add' button located on the main toolbar, select an appropriate command type and specify a unique file sync command name. On the file synchronization command dialog, specify the source and destination directories, select an appropriate file synchronization mode and press the 'Save' button. In order to manually start one or more file synchronization commands, select the required commands in the sync commands view, press the right mouse button and select the 'Start Command' menu item. In order to stop a previously started file synchronization command, select the command in the sync commands view, press the right mouse button and select the 'Stop Command' menu item. 5

6 3.1 Types of File Synchronization Commands IronSync Server provides a number of different types of periodic and real-time file synchronization commands with each one optimized for different needs and usage scenarios. A specific file synchronization command type should be selected for each newly created file synchronization command. In order to add a new file synchronization command, press the 'Add' button located on the main toolbar and select an appropriate file synchronization command type. IronSync provides the following types of file synchronization commands: Periodic File Synchronization Command - this command may be executed manually or automatically triggered using one or more periodic, daily, weekly or monthly sync triggers. Periodic file synchronization commands provide multiple oneway and two-way file synchronization modes, rule-based file synchronization capabilities, error logs, notifications, etc. Every time a periodic file sync command is triggered, IronSync rescans the source and destination directories and synchronizes all changes according to the selected file synchronization mode. All sync actions are performed on-the-fly, without reading or writing any file system state files or databases and therefore periodic file synchronization commands are capable of synchronizing huge file systems containing millions of files very effectively while using a very small amount of system memory and CPU resources. Server-To-Server File Synchronization Command - this command can synchronize files directly between two IronSync Servers without using network shares and optionally compress and encrypt transferred data blocks. Server-To-Server file synchronization commands provide multiple one-way and two-way file synchronization modes, compressed and encrypted file synchronization capabilities, periodic file synchronization capabilities, rule-based file synchronization capabilities, error logs, E- Mail notifications, etc. All file sync actions are performed on-the-fly, without reading or writing any file system state files or databases and therefore server-to-server file synchronization commands are capable of synchronizing huge file systems containing millions of files very effectively while using a very small amount of system memory and CPU resources. Real-Time File Synchronization Command - this command synchronizes changed files on-the-fly as files are changing in the source directory. IronSync Server monitors the source directory, detects individual file changes and synchronizes all changed files to the destination directory. File synchronization is performed in one direction only - from the source directory to the destination directory. Source and destination directories are never scanned and this type of file synchronization commands is especially optimized for effective synchronization of huge file systems containing tens and hundreds of millions of files. Real-Time Directory Synchronization Command - this command synchronizes changed directories on-the-fly as files are changing in the source directory. IronSync Server monitors the source directory, in real-time detects changed subdirectories and performs short sync operations between subdirectories. The user is provided with five different one-way and two-way file synchronization modes. Full scanning of the source and destination directories is never performed, file synchronization is completed in real-time between pairs of changed subdirectories and this type of file synchronization commands is optimized for effective synchronization of huge file systems containing tens and hundreds of millions of files. 6

7 3.2 Periodic File Synchronization Commands Periodic file synchronization commands provide multiple one-way and two-way file synchronization modes, rule-based file synchronization capabilities, file synchronization logs, error notifications, etc. Periodic file sync commands may be executed manually or automatically triggered using one or more daily, weekly or monthly periodic sync triggers. Every time a periodic file sync command is triggered, IronSync rescans the source and destination directories and synchronizes all changed files according to the selected file synchronization mode. All sync actions are performed on-the-fly, without reading or writing any file system state files or databases and therefore periodic file synchronization commands are capable of synchronizing huge file systems containing millions of files very effectively while using a very small amount of system memory and CPU resources. Periodic file synchronization commands provide multiple one-way and two-way file synchronization modes with each one designed for specific needs and usage scenarios. In order to change the file synchronization mode for a periodic file synchronization command, open the command options dialog and select an appropriate file synchronization mode. Periodic file synchronization commands provide the following file synchronization modes: Synchronize Destination Directory (one-way) - All changes made in the source directory will be propagated to the destination directory. Files deleted from the source directory will be deleted from the destination directory. All files changed or deleted in the destination directory will be restored using files from the source directory. No changes will be made in the source directory. After the file synchronization process is complete both locations will be identical. Update Destination Directory (one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No changes will be made in the source directory. Accumulate and Update Files in Destination (one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No files will be deleted from the destination directory. No changes will be made in the source directory. Two-Way File Synchronization - Newly created and modified files will be synchronized in both directions. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored from the source directory. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical. Two-Way Accumulation and Update - Newly created and modified files will be updated in both directions. Files deleted from one location will be restored from the second location. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical. 7

8 3.3 Periodic File Synchronization Triggers Periodic file synchronization commands may be automatically triggered using one or more periodic, daily, weekly or monthly sync triggers. In order to configure sync triggers for a periodic file synchronization command, open the command options dialog and select the 'General' tab. The 'General' tab shows the currently configured sync triggers and allows one to add, delete, enable, disable and configure an unlimited number of sync triggers. In order to add a new sync trigger for a periodic file synchronization command, press the 'Add Trigger' button, select a trigger type, specify all the required parameters and press the 'Ok' button. In order to change a previously configured sync trigger, select the sync trigger in the triggers view, press the right mouse button and select the 'Edit Trigger' menu item. Simple periodic sync triggers provide the ability to execute a sync command every X minutes or hours. Daily triggers provide the ability to execute a sync command every day at a specified time. In order to execute a sync command twice per day at different times, the user can add two daily triggers with each one configured to trigger the sync command at a different time. Weekly triggers provide the ability to specify days of the week and a time of the day to execute the sync command. Multiple weekly triggers may be used to execute the sync command at different times on different week days. In addition, users are provided with monthly sync triggers allowing one to execute a sync command on specific days of month. Finally, IronSync provides a single time sync trigger allowing one to execute a sync command one time only at a specified date and time. 8

9 3.4 Server-To-Server File Synchronization Commands Server-to-Server file synchronization commands can synchronize files directly between two IronSync Servers without using network shares and optionally compress and encrypt transferred data blocks. Server-To-Server file synchronization commands provide multiple one-way and two-way file synchronization modes, compressed and encrypted file synchronization capabilities, rule-based file synchronization capabilities, file synchronization logs, error notifications, etc. Server-To-Server commands may be executed manually or automatically triggered using one or more daily, weekly or monthly periodic sync triggers. Server-To-Server file synchronization commands provide multiple one-way and two-way file synchronization modes with each one designed for specific needs and usage scenarios. In order to change the file synchronization mode for a server-to-server file sync command, open the command options dialog and select an appropriate file synchronization mode. Server-To-Server file synchronization commands provide the following additional options: Verify Transferred Data Blocks - when this option is enabled IronSync Server verifies the SHA256 hash signature for each transferred data block and automatically retransmits all corrupted data blocks. Compress Transferred Data Blocks - when this option is enabled IronSync Server compresses each transferred data block thus minimizing the amount of data transferred through the network. Encrypt Transferred Data Blocks - when this option is enabled IronSync Server encrypts each transferred data block using the AES-256 encryption algorithm with dynamically changed encryption keys. Every time a server-to-server file sync command is triggered, IronSync rescans the source and destination directories and synchronizes all changed files according to the selected file synchronization mode. All sync actions are performed on-the-fly, without reading or writing any file system state files or databases and therefore server-to-server file synchronization commands are capable of synchronizing huge file systems containing millions of files very effectively while using a very small amount of system memory and CPU resources. 9

10 3.5 Real-Time File Synchronization Commands Real-Time file synchronization commands synchronize changed files on-the-fly as files are changing in the source directory. IronSync Server monitors the source directory, detects individual file changes and synchronizes all changed files to the destination directory. File synchronization is performed in one direction only - from the source directory to the destination directory. Source and destination directories are never scanned and this type of file synchronization commands is especially optimized for effective synchronization of huge file systems containing tens and hundreds of millions of files. In order to add a real-time file synchronization command, press the 'Add' button located on the main toolbar, select the 'Real-Time File Synchronization' command type, enter a unique command name, specify the source and destination directories and press the 'Save' button. Real-Time file synchronization commands can be started manually or automatically when the computer starts. In order to enable auto start for a real-time file synchronization command, select the command in the commands view, press the right mouse button, select the 'Edit Command' menu item, select the 'General' tab and select the 'Auto Start' command option. A real-time file synchronization command may be configured to synchronize specific types of files or file groups using flexible file matching rules. In order to add one or more file matching rules to a real-time file synchronization command, open the command options dialog, select the 'Rules' tab, press the 'Add' button and select an appropriate rule type. For example, the user is provided with the ability to sync all types of documents with the file size more than X MB and/or a text pattern in the file name. 10

11 3.6 Real-Time Directory Synchronization Commands Real-Time directory synchronization commands synchronize changed directories on-the-fly as files are changing in the source directory. IronSync Server monitors the source directory, in real-time detects changed subdirectories and performs short sync operations between subdirectories without scanning the complete directory tree. The user is provided with five different one-way and two-way file synchronization modes. Full scanning of the source and destination directories is never performed and file synchronization is completed in real-time between pairs of changed subdirectories. In order to change the file synchronization mode for a file synchronization command, open the file synchronization command options dialog and select one of the following file synchronization modes: Synchronize Destination Directory (one-way) - All changes made in the source directory will be propagated to the destination directory. Files deleted from the source directory will be deleted from the destination directory. All files changed or deleted in the destination directory will be restored using files from the source directory. No changes will be made in the source directory. After the file synchronization process is complete both locations will be identical. Update Destination Directory (one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No changes will be made in the source directory. Accumulate and Update Files in Destination (one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No files will be deleted from the destination directory. No changes will be made in the source directory. Two-Way File Synchronization - Newly created and modified files will be synchronized in both directions. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored from the source directory. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical. Two-Way Accumulation and Update - Newly created and modified files will be updated in both directions. Files deleted from one location will be restored from the second location. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical. 11

12 3.7 Advanced File Synchronization Options IronSync provides a large number of advanced file synchronization options allowing one to customize file synchronization operations for user-specific needs and hardware configurations. In order to open the file synchronization options dialog, select a file synchronization command in the sync commands view, press the right mouse button and select the 'Edit Command' menu item. The 'Advanced' tab allows one to control the number of parallel file synchronization threads, the number of parallel directory scanning threads, the performance mode and the file synchronization preview mode, which may be used to test advanced file synchronization options before executing file synchronization operations on production data. The 'Options' tab provides the ability to control which meta data is synchronized when files are copied from one directory to another. In addition, the user is provided with the ability to enable the bit-level file synchronization option for any file synchronization command. With this option enabled, IronSync Server will compare and update individual data blocks in files that should be synchronized thus minimizing the amount of data written to the disk. Finally, IronSync Server provides the ability to verify the integrity of copied files by comparing hash signatures of source and destination files after each file copy operation. 12

13 3.8 Synchronizing Specific Types of Files Sometimes, it may be required to synchronize specific types of files or groups of files according to user-specific needs and requirements. IronSync provides a large set of file matching rules allowing one to synchronize files by the file type, extension, size, file name, directory, attributes, user name, etc. The user is provided with the ability to add a number of file matching rules to any file synchronization operation specifying which files to synchronize. For example, IronSync allows one to synchronize all types of document files with the file size more than X MB and a text pattern in the file name. The user is provided with the ability to combine different types of file matching rules and logical operators precisely selecting files that should be synchronized. In addition to positive file matching rules, the user is provided with negative file matching rules, which can be used to exclude specific types or groups of files from the file synchronization process. For example, IronSync allows one to exclude all types of images owned by a specific user and having the system file attribute. Various types of positive and negative file matching rules may be combined into sophisticated, multi-level file filters precisely selecting which files to synchronize and which files to exclude from the file synchronization process. 13

14 3.9 Excluding Directories From File Synchronization Sometimes, it may be required to exclude one or more subdirectories from the file synchronization process. For example, if you need to synchronize two directories excluding one or two special subdirectories, you may specify the top level directories as the source and destination directories and add the subdirectories that should be skipped to the exclude list. In order to add one or more directories to the exclude list, open the file synchronization command options dialog, select the 'Exclude' tab and add one or more directories to the exclude directories list. All files and subdirectories located in the specified exclude directories will be excluded from the file synchronization process. In addition, advanced users are provided with a number of exclude directories macro commands allowing one to exclude multiple directories using a single macro command. IronSync Server provides the following exclude directories macro commands: $BEGINS <Text String> - this macro command excludes all directories beginning with the specified text string. $CONTAINS <Text String> - this macro command excludes all directories containing the specified text string. $ENDS <Text String> - this macro command excludes all directories ending with the specified text string. $REGEX <Regular Expression> - this macro command excludes directories matching the specified regular expression. For example, the exclude macro command '$CONTAINS Temporary Files' will exclude all directories with 'Temporary Files' at any place in the full directory path and the exclude macro command '$REGEX \.(TMP TEMP)$' will exclude directories ending with '.TMP' or '.TEMP'. 14

15 3.10 File Synchronization Logs and Error Notifications IronSync provides a number of file synchronization logs and error notification options allowing one to keep file synchronization operations under control. In order to enable error notifications for a file synchronization command, open the file synchronization command dialog, select the 'Misc' tab, select the 'Send Error Notifications' option and specify an address to send error notifications to. In addition, in order to enable notifications, the user needs to open the 'Options' dialog, select the ' ' tab and specify an SMTP server to use to send notifications. Error notifications are sent when a file synchronization operation is aborted due to a critical error such as no disk space on the destination device or when there are too many noncritical errors. In addition to error notifications, the user is provided with the ability to save file synchronization error logs in a user-specified directory. Finally, in order to simplify testing of sophisticated file synchronization operations, IronSync provides the ability to save full file synchronization logs including all file synchronization actions performed by a file synchronization operation. File synchronization logs and error notifications may be enabled for each file synchronization command individually and globally for all file synchronization commands on the IronSync Server 'Options' dialog. File synchronization logs and error notifications options specified for a file synchronization command take precedence over global file synchronization logs and error notification options specified on the IronSync Server 'Options' dialog. 15

16 3.11 Connecting to IronSync Server Through the Network The IronSync client GUI application allows one to control one or more IronSync Servers locally or via the network. In order to connect to a remote IronSync server, open the client GUI application, press the 'Connect' button located on the main toolbar and specify a host name or an IP address of the server to connect to. In order to prevent unauthorized access to the IronSync Server, all communication between the client GUI application and the remote IronSync server is performed using an AES-256 encrypted network protocol with randomly selected and dynamically changed keys for each session. By default, the IronSync client GUI application uses the TCP/IP port 9142 to connect to the IronSync Server and in order to be able to connect through the network, the port should be open in the server's firewall. When the IronSync client GUI application is connected to a server, the name of the server is displayed on the status bar, the sync commands view shows file synchronization commands configured on the server and the message log view shows last status messages from the IronSync server. In order to see more information about the IronSync Server, select the menu 'Help - About' and the IronSync client GUI application will display server's 'About' dialog. 16

17 3.12 Using IronSync to Synchronize Network Shares By default, the IronSync service is configured to run under the local system account, which is good to synchronize local disks and directories. On the other hand, the local system account does 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 storage devices, the IronSync service should be configured to run under a user account, which has permissions 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 the following 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 storage devices. 17

18 3.13 Configuring IronSync Server IronSync Server provides a large number of advanced configuration options allowing one to customize the product for user-specific needs and requirements. In order to open the 'Options' dialog, open the IronSync client GUI application, connect to a server and press the 'Options' button located on the main toolbar. When the user opens the 'Options' dialog, the client GUI application requests server configuration options from the IronSync Server and updates configuration options on the server side when the user closes the 'Options' dialog. The 'General' tab provides a large number of general-purpose options allowing one to control how IronSync scans directories, handles errors and reports about different types of file synchronization errors. The 'Server' tab provides the ability to customize the IronSync Server user name and password used by the IronSync client GUI application and the command line utility to login to the IronSync Server. By default, IronSync Server is configured to use the 'admin/admin' user name and password, which can be changed to any arbitrary user name and password. In order to prevent unauthorized access to the IronSync Server, all communication between the client GUI application and the IronSync server is performed using an AES-256 encrypted network protocol with randomly selected and dynamically changed keys for each session. In addition, the 'Server' tab provides the ability to customize the server control port used by the IronSync client GUI application and the command line utility to connect to the server. Finally, the user is provided with the ability to customize the web management interface port used by web browsers to connect to the IronSync server. If the IronSync server should be controlled via the network, one or both of these ports should be open in the server's firewall. 18

19 The 'Advanced' tab allows one to control the maximum number of file synchronization errors and the maximum number of consecutive errors to abort a file synchronization operation. In addition, the user is provided with the ability to control the file copy verification mode, specify a global file synchronization error logs directory, a global sync logs directory and a global E- Mail address to send error notifications to. If a global log directory is specified, IronSync Server will save error logs and/or sync logs for all file synchronization commands configured in the IronSync Server. In addition to the global log directories, the user is provided with the ability to configure log directories for each file synchronization command individually on the file synchronization command options dialog. The ' ' tab provides the ability to specify an SMTP server to use to send error notifications. If a global error notifications address is specified, IronSync Server will send error notifications to the global address for all failed file synchronization operations. In addition, to the global error notifications address, the user is provided with the ability to configure an individual error notification address for each file synchronization command on the file synchronization command options dialog. 19

20 3.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 released every year. New product versions and product updates are published on the product web site and may be downloaded on the following page: Due to the fact that the product is especially designed for servers running in production environments where stability is a major decision factor, IronSync Server updates should be manually 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. All product configuration files, configured file synchronization commands and product registration will remain valid and there is nothing to reconfigure or manage after the update. 20

21 3.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 unlock key, which should be used to register the product. If you will not receive your unlock key within 24 hours, please check your spam box and if the unlock key is not in the spam box contact our support team: support@flexense.com. If the computer where the IronSync Server is installed on is connected to the Internet, connect to the IronSync Server using the client GUI application, press the 'Register' button located in the top-right corner, enter your name or your company name as the customer name, enter the received unlock key and press the 'Register' button. If the computer is not connected to the Internet, press the 'Manual Registration' button, export a product ID file and send the product ID file to register@ironsync.com as an attachment. Within a couple of hours, you will receive an unlock file, which should be imported in order to finish the registration procedure. 21

22 4 Using Web-Based Interface IronSync Server provides a complete web-based management interface allowing one to control, manage and configure one or more IronSync servers locally or via the network using a standard web browser. By default, the web-based interface is disabled and in order to enable the web-based management interface, connect to the IronSync server using the client GUI application, open the 'Options' dialog, select the 'Server' tab, select the 'Enable Web Server' option and press the 'Save' button. In order to connect to the IronSync Server using a regular web browser, enter the host name or an IP address of the server in the address bar and login using the default user name and password: admin/admin. By default, the web-based management interface uses the TCP/IP port 80, which is the standard port used by web browsers to connect to web servers, and in order to be able to manage the IronSync server via the network, the web interface port should be open in the server's firewall. The IronSync Server web-based management interface is a dynamic web application, which shows the current status of the server and the progress of file synchronization operations without reloading the currently displayed web page. In order to operate properly, the webbased interface requires JavaScript to be enabled in the web browser. 22

23 4.1 File Synchronization Command Types IronSync Server provides multiple different types of periodic, server-to-server and real-time file synchronization commands with each one optimized for different needs and usage scenarios. A specific file synchronization command type should be selected for each newly created file synchronization command. In order to add a new file synchronization command, press the 'Add Command' button located on the IronSync Server home page, enter a command name and select an appropriate file synchronization command type. IronSync Server provides the following types of file synchronization commands: Periodic File Synchronization Command - this command may be executed manually or automatically triggered using one or more periodic, daily, weekly or monthly sync triggers. Periodic file synchronization commands provide multiple oneway and two-way file synchronization modes, rule-based file synchronization capabilities, error logs, notifications, etc. Every time a periodic file sync command is triggered, IronSync rescans the source and destination directories and synchronizes all changes according to the selected file synchronization mode. All sync actions are performed on-the-fly, without reading or writing any file system state files or databases and therefore periodic file synchronization commands are capable of synchronizing huge file systems containing millions of files very effectively while using a very small amount of system memory and CPU resources. Server-To-Server File Synchronization Command - this command can synchronize files directly between two IronSync Servers without using network shares and optionally compress and encrypt transferred data blocks. Server-To-Server file synchronization commands provide multiple one-way and two-way file synchronization modes, compressed and encrypted file synchronization capabilities, periodic file synchronization capabilities, rule-based file synchronization capabilities, error logs, E- Mail notifications, etc. All file sync actions are performed on-the-fly, without reading or writing any file system state files or databases and therefore server-to-server file synchronization commands are capable of synchronizing huge file systems containing millions of files very effectively while using a very small amount of system memory and CPU resources. Real-Time File Synchronization Command - this command synchronizes changed files on-the-fly as files are changing in the source directory. IronSync Server monitors the source directory, detects individual file changes and synchronizes all changed files to the destination directory. File synchronization is performed in one direction only - from the source directory to the destination directory. Source and destination directories are never scanned and this type of file synchronization commands is especially optimized to effectively synchronize file systems with millions of files. Real-Time Directory Synchronization Command - this command synchronizes changed directories on-the-fly as files are changing in the source directory. IronSync Server monitors the source directory, in real-time detects changed subdirectories and performs short sync operations between subdirectories. The user is provided with five different one-way and two-way file synchronization modes. Full scanning of the source and destination directories is never performed, file synchronization is completed in real-time between pairs of changed subdirectories and this type of file synchronization commands is optimized to effectively synchronize file systems with millions of files. 23

24 4.2 Managing File Synchronization Commands IronSync Server allows one to setup an unlimited number of file synchronization commands with each one synchronizing files from a source disk or directory to a destination disk or directory. In order to setup one or more file synchronization commands, login to the IronSync Server web-based management console using a standard web browser. On the IronSync Server status page, press the 'Add Command' button, enter a unique command name, select an appropriate file synchronization command type, enter a source directory, which should be a local disk or directory, and enter a destination directory, which may be set to a local disk, directory or a network share, and press 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 the command name link to see an extended status of the command. In order to stop an active file synchronization command, click on the 'Stop' link located on the right side of the file synchronization command. 24

25 4.3 Periodic File Synchronization Commands Periodic file synchronization commands provide multiple one-way and two-way file synchronization modes, rule-based file synchronization capabilities, error logs, notifications, etc. Periodic file synchronization commands may be executed manually or automatically triggered using one or more periodic, daily, weekly or monthly sync triggers. Every time a periodic file sync command is triggered, IronSync rescans the source and destination directories and synchronizes all changed files according to the selected file synchronization mode. All sync actions are performed on-the-fly, without reading or writing any file system state files or databases and therefore periodic file synchronization commands are capable of synchronizing huge file systems containing millions of files very effectively while using a very small amount of system memory and CPU resources. 25

26 Periodic file synchronization commands provide multiple one-way and two-way file synchronization modes with each one designed for specific needs and usage scenarios. In order to change the file synchronization mode for a periodic file synchronization command, open the command 'Edit' page and select an appropriate file synchronization mode. Periodic file synchronization commands support the following file synchronization modes: Synchronize Destination Directory (one-way) - All changes made in the source directory will be propagated to the destination directory. Files deleted from the source directory will be deleted from the destination directory. All files changed or deleted in the destination directory will be restored using files from the source directory. No changes will be made in the source directory. After the file synchronization process is complete both locations will be identical. Update Destination Directory (one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No changes will be made in the source directory. Accumulate and Update Files in Destination (one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No files will be deleted from the destination directory. No changes will be made in the source directory. Two-Way File Synchronization - Newly created and modified files will be synchronized in both directions. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored from the source directory. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical. Two-Way Accumulation and Update - Newly created and modified files will be updated in both directions. Files deleted from one location will be restored from the second location. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical. 26

27 Periodic file synchronization commands may be automatically triggered using one or more periodic, daily, weekly or monthly sync triggers. In order to configure sync triggers for a periodic file synchronization command, open the command 'Edit' page and press the 'Triggers' button. The 'Sync Triggers' page shows the currently configured sync triggers and allows one to add, delete, enable, disable and configure an unlimited number of sync triggers. In order to add a new sync trigger for a periodic file synchronization command, press the 'Add Trigger' button, select a trigger type, specify all the required parameters and press the 'Add' button. In order to change a previously configured sync trigger, click on the trigger's 'Edit' button located in the 'Tools' column. Simple periodic sync triggers provide the ability to execute a sync command every X minutes or hours. Daily sync triggers provide the ability to execute a sync command every day at a specified time. In order to execute a sync command twice per day at different times, the user can add two daily triggers with each one configured to trigger the sync command at a different time. Weekly triggers provide the ability to specify days of week (from 1 to 7 delimited by the comma character) and a time of the day to execute the sync command. Multiple weekly triggers may be used to execute the sync command at different times on different week days. In addition, users are provided with monthly sync triggers allowing one to execute a sync command on specific days of month. Finally, IronSync provides a single time sync trigger allowing one to execute a sync command one time only at a specified date and time. 27

28 4.4 Real-Time Directory Synchronization Commands Real-Time directory synchronization commands synchronize changed directories on-the-fly as files are changing in the source directory. IronSync Server monitors the source directory, in real-time detects changed subdirectories and performs short sync operations between subdirectories without scanning the complete directory tree. The user is provided with five different one-way and two-way file synchronization modes. Full scanning of the source and destination directories is never performed and file synchronization is completed in real-time between pairs of changed subdirectories. In order to change the file synchronization mode for a file synchronization command, open the file synchronization command configuration page and select one of the following file synchronization modes: Synchronize Destination Directory (one-way) - All changes made in the source directory will be propagated to the destination directory. Files deleted from the source directory will be deleted from the destination directory. All files changed or deleted in the destination directory will be restored using files from the source directory. No changes will be made in the source directory. After the file synchronization process is complete both locations will be identical. Update Destination Directory (one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No changes will be made in the source directory. Accumulate and Update Files in Destination (one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No files will be deleted from the destination directory. No changes will be made in the source directory. Two-Way File Synchronization - Newly created and modified files will be synchronized in both directions. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored from the source directory. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical. Two-Way Accumulation and Update - Newly created and modified files will be updated in both directions. Files deleted from one location will be restored from the second location. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical. 28

29 4.5 Advanced File Synchronization Commands Options In order to access advanced file synchronization command options, click on the 'Edit Command' 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 more exclude 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 notifications when the command is aborted due to a hardware problem. Another very useful feature is the sync preview mode, which may be enabled for any file synchronization command on the advanced options page. In the preview mode, IronSync will monitor the source directory, examine all detected file system changes and calculate the expected change rate without performing any actions in the destination directory. This mode allows one to analyze a frequently changing file system and estimate expected performance requirements in order to properly select a fast enough backup device to be used as a destination directory for a file synchronization command. IronSync Server provides the ability to perform initial file synchronization for static files existed in the source directory before the file synchronization command was started for the first time. In order to enable initial file synchronization for a sync command, open the main command 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 of real-time sync actions should be performed and automatically resumed when the number of pending sync actions drops below a user-configurable limit. The 'Initial Sync Start Limit' option sets the number of pending file system changes or pending sync actions triggering the start of the initial file synchronization operation. The 'Initial Sync Stop Limit' option sets the number of pending file system changes or pending sync actions triggering 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 resumed and when the number of pending actions raises above the stop limit, the initial sync operation is paused. 29

30 4.6 Synchronizing Specific Types of Files Sometimes, it may be required to synchronize files related to a specific file type or category according to user-specific needs while skipping all other files. IronSync Server allows one to specify which types of files should be synchronized by a file synchronization command. The user 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 all types of documents with the file size more than 10 MB and the file name 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. On the 'Rules' page press the 'Add Rule' button, select an appropriate rule type, operator, a rule value 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 of hierarchical nested rules combined with logical operators and allowing one to precisely select types of files that should be synchronized. 30

31 4.7 File Synchronization Options Additional file synchronization options may be controlled on the 'File Sync Options' page. In order to open the file synchronization options page open the file synchronization command page and press the 'Options' button. Sync File Attributes - select this option if you wish to sync file attributes for all files copied 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 file ownership 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 to copy 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 this option is disabled). Skip System Files and Directories - select this option if you wish to skip all system files and directories from the file synchronization process (by default this option is enabled). Skip Hidden Files and Directories - select this option if you wish to skip all hidden files and directories from the file synchronization process (by default this option is enabled). Bit-Level File Synchronization - select this option if you wish to copy only changed data 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 to the destination directory (by default this option is disabled). * All security related options require administrative privileges and the IronSync service needs to be configured to run under a user account having enough permissions to access all the required network shares and perform DACL and SACL copy operations. 31

32 4.8 Excluding Directories From File Synchronization Sometimes, it may be required to exclude one or more subdirectories from the file synchronization process. For example, if you need to synchronize two directories excluding one or two special subdirectories, you may specify the top level directories as the source and destination directories and add the subdirectories that should be skipped to the exclude list. In order to add one or more directories to the exclude list, open the file synchronization command configuration page, press the 'Advanced Options' button and add one or more directories to the exclude directories list separated by the semicolon (;) character. All files and subdirectories located in the specified exclude directories will be excluded from the file synchronization process. In addition, advanced users are provided with a number of exclude directories macro commands allowing one to exclude multiple directories using a single macro command. IronSync Server provides the following exclude directories macro commands: $BEGINS <Text String> - this macro command excludes all directories beginning with the specified text string. $CONTAINS <Text String> - this macro command excludes all directories containing the specified text string. $ENDS <Text String> - this macro command excludes all directories ending with the specified text string. $REGEX <Regular Expression> - this macro command excludes directories matching the specified regular expression. For example, the exclude macro command '$CONTAINS Temporary Files' will exclude all directories with 'Temporary Files' at any place in the full directory path and the exclude macro command '$REGEX \.(TMP TEMP)$' will exclude directories ending with '.TMP' or '.TEMP'. 32

33 4.9 Configuring IronSync Server IronSync Server provides a variety of configuration options allowing one to easily integrate the product 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 IronSync user name and password. The default user name and password is set to: admin/admin. In addition, IronSync Server provides the ability to set a custom user name and/or password for the IronSync web-based management interface and the command line utility, which may be used to automate configuration and management tasks. In order to set a custom user name and password, click on the 'Configure Server Login' link located on the main settings page, enter a new user name and password and press the 'Save' button. 33

34 4.11 Configuring Error Handling Options IronSync Server provides a number of advanced error handing, recovery and notification options. In order to open the error handling page, go to the main settings page and click on the 'Logs and Notifications' link. Default error handling settings should be good enough for most users, but if required, the user is provided with the ability to customize the maximum number of errors per sync command, the maximum number of consecutive errors, the maximum number of retries to perform for each locked file and the initial retry delay. In addition, IronSync Server provides the ability to set a global logs directory and/or a global notification address to send notifications about failed file synchronization commands. If the global logs directory and/or error notifications are enabled, IronSync will save error logs and/or send notifications for all failed file synchronization commands. File synchronization commands explicitly configured to save error logs to a different directory and/or send notifications to a different address take precedence over the global settings. 34

35 4.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/IP port 80 as the default web access port. Sometimes, these ports may be in use by some other software products or system services. If one or both of these ports are in use, IronSync will be unable 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 Server Ports' link located on the main settings page, select the 'Use Custom Port' option and enter a custom 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 Notifications IronSync Server provides the ability to send notifications when a file synchronization command fails due to a hardware problem. In order to configure an SMTP server to use to send notifications, click on the 'Configure Server' link located on the main settings page, enter the SMTP server host name, SMTP server port, SMTP user name, password and the source address to use to send notifications. 35

36 4.14 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 unlock key, which should be used to register the product. If you will not receive your unlock key within 24 hours, please check your spam box and if the unlock key is not in the spam box contact our support team: support@flexense.com. If the computer where IronSync Server is installed on is connected to the Internet, login to the IronSync 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 and press 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 register@ironsync.com as an attachment. Within a couple of hours, you will receive an unlock file, which should be imported in order to finish the registration procedure. 36

37 4.15 OEM Product Version Flexense provides system integrators, value-added distributors and IT service providers with the ability to resell IronSync Server and/or provide services based on the product under thirdparty brand names. Resellers and integrators are provided with the ability to change the product name, the product web site address, the product vendor name and the product vendor web site address. In order to be able to set custom OEM product and vendor information, the user needs to register the product using a special OEM-Enabled unlock key, which may be purchased on the product purchase page. Once the product is registered using an OEM unlock key, open the 'About' page, press the 'Set OEM Info' button, specify your custom OEM product and vendor information and press the 'Save' button. Custom OEM product and vendor information will be displayed on all pages of the IronSync web-based management interface, in all types of reports generated by the product and all notification messages sent by IronSync Server. 37

38 5 Using IronSync Command Line Utility In addition to the client GUI application and the web-based management interface, IronSync Server provides a command line utility, which may be used to control, manage and configure one or more IronSync Servers locally or through the network. By default, the IronSync command line utility is located in the '<Product Dir>\bin' directory. The command line utility may be executed with a variety of command line parameters and options allowing one to automate control, configuration and management of one or more IronSync Servers using batch files or shell scripts. For detailed information about available command line options, execute the command line utility with the '-help' command line parameter. IronSync Command Line Utility Usage: ironsync -show_commands Shows file synchronization commands configured in the IronSync Server. ironsync -add_command <Name> -type <Type> -source <Dir> -dest <Dir> Adds a new file synchronization command. The command type should be set to one of the following values: FSD - Periodic File Synchronization Command RTF - Real-Time File Synchronization Command RTD - Real-Time Directory Synchronization Command ironsync -start_command <Command Name> Starts the specified file synchronization command. ironsync -stop_command <Command Name> Stops the specified file synchronization command. ironsync -command_status <Command Name> Shows the current status of the specified file synchronization command. 38