Professional Documents
Culture Documents
IronSync File Synchronization Server
IronSync File Synchronization Server
Flexense Ltd.
IronSync
File Sync Server
User Manual
Version 1.8
Jun 2013
Flexense Ltd.
Product Overview
IronSync Server is a powerful file synchronization server providing multiple types of periodic and real-time file synchronization operations. IronSync is a highly scalable file synchronization solution especially designed to effectively synchronize huge file systems containing millions of files. Users are provided with multiple one-way and two-way file synchronization modes, periodic and real-time file synchronization capabilities, E-Mail notifications, error logs, 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 web-based management interface 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 of files to synchronize, customize error recovery options, enable error logs and/or send E-Mail notifications when a sync command fails due to a hardware problem.
Flexense Ltd.
The installation package is very small, 4MB - 5MB 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 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.
Flexense Ltd.
Web-Based Interface
IronSync Server provides a complete web-based management interface, which allows one to fully control, manage and configure one or more IronSync servers locally or though the network using a standard Web browser. By default, the web-based interface uses the TCP/IP port 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 of the 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 current status of the server and the progress of performed operations without reloading the currently displayed web page. In order to operate properly, the web-based interface requires JavaScript to be enabled in the web browser.
Flexense Ltd.
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, E-Mail 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. 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.
Flexense Ltd.
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.
Flexense Ltd.
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.
Flexense Ltd.
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.
Flexense Ltd.
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.
Flexense Ltd.
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.
10
Flexense Ltd.
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.
11
Flexense Ltd.
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.
12
Flexense Ltd.
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.
13
Flexense Ltd.
The configuration is very simple and may be performed within a couple of seconds using the following step-by-step guide: 1. 2. 3. 4. 5. Open the Windows control panel and click on the 'Administrative Tools' utility. Open the Services control center and find the 'IronSync Server' service. Open the 'IronSync Server' service, select the 'General' tab and stop the service. Select the 'Log On' tab and specify a user account to use for the IronSync service. 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.
14
Flexense Ltd.
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.
15
Flexense Ltd.
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 E-Mail 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 E-Mail address take precedence over the global settings.
16
Flexense Ltd.
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.
17
Flexense Ltd.
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.
18
Flexense Ltd.
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.
19
Flexense Ltd.
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.
20
Flexense Ltd.
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 E-Mail messages sent by IronSync Server.
21
Flexense Ltd.
64-Bit Operating Systems Windows Windows Windows Windows Windows Windows Windows XP 64-Bit Vista 64-Bit 7 64-Bit 8 64-Bit Server 2003 64-Bit Server 2008 64-Bit Server 2012 64-Bit
System Requirements
Minimal System Configuration Supported Operating System Single Core 1 GHz or better CPU 512 MB of system memory 25 MB of free disk space
Recommended System Configuration Supported Operating System Dual Core 2 GHz or better CPU 1 GB of system memory 25 MB of free disk space
* Internet Explorer v9, FireFox v12 or Chrome v17 or newer is required for proper operation of the web-based management interface.
22