IronSync Server Manual v2.4

8/12/2019 IronSync Server Manual v2.4

1/40

IronSync File Synchronization Server Flexense Ltd.

1

User Manual

Version 2.4

Mar 2014

www.ironsync.com [email protected]

Flexense Ltd.

IronSyncFILE SYNC SERVER


2/40


2

1 Product Overview................................................................................................3

2 Product Installation Procedure ...........................................................................4

3 Using IronSync Client UI !""lication ................................................................#

3.1 Types of File Synchronization ommands ..............................................................!

3.2 "eriodic File Synchronization ommands ...............................................................# 3.3 "eriodic File Synchronization Tri$$ers ...................................................................% 3.& Server'To'Server File Synchronization ommands..................................................( 3.) *eal'Time File Synchronization ommands .......................................................... 1+ 3.! *eal'Time ,irectory Synchronization ommands..................................................11 3.# -dvanced File Synchronization ptions ...............................................................12 3.% Synchronizin$ Specific Types of Files ..................................................................13 3.( /xcl0din$ ,irectories From File Synchronization ...................................................1& 3.1+ File Synchronization Lo$s and /rror otifications ..................................................1) 3.11 onnectin$ to IronSync Server Thro0$h the etwor ............................................ 1! 3.12 sin$ IronSync to Synchronize etwor Shares ...................................................1# 3.13 onfi$0rin$ IronSync Server ..............................................................................1% 3.1& "rod0ct pdate "roced0re .................................................................................2+ 3.1) "rod0ct *e$istration "roced0re ..........................................................................21

4 Using $e%&'ased Inter(ace...............................................................................22

&.1 File Synchronization ommand Types .................................................................23 &.2 4ana$in$ File Synchronization ommands...........................................................2& &.3 "eriodic File Synchronization ommands ............................................................. 2) &.& *eal'Time ,irectory Synchronization ommands..................................................2% &.) -dvanced File Synchronization ommands ptions...............................................2( &.! Synchronizin$ Specific Types of Files ..................................................................3+ &.# File Synchronization ptions ..............................................................................31 &.% /xcl0din$ ,irectories From File Synchronization ...................................................32 &.( onfi$0rin$ IronSync Server ..............................................................................33 &.1+ onfi$0rin$ ser ame and "assword .................................................................33 &.11 onfi$0rin$ /rror 5andlin$ ptions.....................................................................3& &.12 onfi$0rin$ Server ontrol and 6e7 -ccess "orts.................................................3) &.13 onfi$0rin$ /'4ail otifications..........................................................................3) &.1& "rod0ct *e$istration "roced0re ..........................................................................3! &.1) /4 "rod0ct 8ersion ........................................................................................3#

# Using IronSync Co))and *ine Utility ...............................................................3+

, Su""orted O"erating Syste)s...........................................................................40

- Syste) e/uire)ents .......................................................................................40


3/40


3

1 Product Overview

IronSync Server is a powerf0l file synchronization sol0tion providin$ m0ltiple types of periodic9server'to'server and real'time file synchronization operations. IronSync is a hi$hly scala7lefile synchronization sol0tion especially desi$ned to effectively synchronize h0$e file systemscontainin$ tens of millions of files. sers are provided with m0ltiple one'way and two'way filesynchronization modes9 periodic and real'time file synchronization capa7ilities9 compressedand encrypted file synchronization capa7ilities9 file synchronization lo$s9 /'4ail notifications9file synchronization statistics reports9 etc.

IronSync is optimized for modern hardware architect0res and is capa7le of effectively 0tilizin$m0lti'core " s and m0lti' " servers while synchronizin$ millions of files in real'time. n

the other hand9 IronSync Server is especially desi$ned to r0n on prod0ction servers 0sin$ avery small amo0nt of the system memory :!4;'%4;< and " reso0rces in order to minimizethe performance impact on r0nnin$ prod0ction applications.

IronSync Server r0ns as a service in the 7ac $ro0nd and provides a client = I application9 acommand line 0tility and a we7'7ased mana$ement interface allowin$ one to control9confi$0re and mana$e one or more IronSync Servers locally or thro0$h the networ . The 0ser

is provided with the a7ility to set0p m0ltiple file synchronization commands9 specify excl0dedirectories9 synchronize specific types of files9 c0stomize error recovery options9 ena7le errorlo$s and>or send /'4ail notifications when a sync command fails d0e to a hardware pro7lem.


4/40


&

2 Product Installation Procedure

IronSync Server is especially desi$ned to 7e as simple as possi7le. The prod0ct does notre?0ire any third'party software applications and may 7e installed and confi$0red within aco0ple of min0tes. - f0lly f0nctional 3+'days trial version of IronSync Server may 7edownloaded on the followin$ pa$e http >>www.ironsync.com>downloads.html .

The installation pac a$e is very small9 !4; ' #4; dependin$ on the tar$et operatin$ system9and the prod0ct re?0ires A0st 2+4; of the free dis space on the tar$et server. In order toinstall IronSync Server9 start the set0p pro$ram9 select a destination directory and press theB extB 70tton.

ptionally9 enter c0stom server control and>or we7 access ports. The server control port is0sed 7y the IronSync client = I application and the command line 0tility to connect to theserver and the we7 access port is the port for the we7'7ased mana$ement interface allowin$

one to control IronSync Server 0sin$ a standard we7 7rowser. If IronSync Server sho0ld 7econtrolled remotely thro0$h the networ 9 ma e s0re one or 7oth of these ports are open in theserverBs firewall.


5/40


)

3 Using IronSync Client UI !""lication

The IronSync Server client = I application provides the a7ility to confi$0re and control filesynchronization commands9 set0p periodic file synchronization operations9 c0stomize filesynchronization lo$s and error handin$ options. The client = I application may 7e 0sed tocontrol one or more IronSync Servers locally or via the networ .

The IronSync client = I application shows the stat0s of confi$0red file synchronizationoperations in the top view and the IronSync Server messa$e lo$ in the 7ottom view. In orderto add a file synchronization command9 press the B-ddB 70tton located on the main tool7ar9

select an appropriate command type and specify a 0ni?0e file sync command name. n thefile synchronization command dialo$9 specify the so0rce and destination directories9 select anappropriate file synchronization mode and press the BSaveB 70tton.

In order to man0ally start one or more file synchronization commands9 select the re?0iredcommands in the sync commands view9 press the ri$ht mo0se 70tton and select the BStartommandB men0 item. In order to stop a previo0sly started file synchronization command9select the command in the sync commands view9 press the ri$ht mo0se 70tton and select theBStop ommandB men0 item.


6/40


!

3.1 y"es o( ile Sync roni ation Co))ands

IronSync Server provides a n0m7er of different types of periodic and real'time filesynchronization commands with each one optimized for different needs and 0sa$e scenarios. -specific file synchronization command type sho0ld 7e selected for each newly created filesynchronization command. In order to add a new file synchronization command9 press the

B-ddB 70tton located on the main tool7ar and select an appropriate file synchronizationcommand type. IronSync provides the followin$ types of file synchronization commands

Periodic ile Sync roni ation Co))and ' this command may 7e exec0tedman0ally or a0tomatically tri$$ered 0sin$ one or more periodic9 daily9 wee ly ormonthly sync tri$$ers. "eriodic file synchronization commands provide m0ltiple one'way and two'way file synchronization modes9 r0le'7ased file synchronizationcapa7ilities9 error lo$s9 /'4ail notifications9 etc. /very time a periodic file synccommand is tri$$ered9 IronSync rescans the so0rce and destination directories andsynchronizes all chan$es accordin$ to the selected file synchronization mode. -ll syncactions are performed on'the'fly9 witho0t readin$ or writin$ any file system state filesor data7ases and therefore periodic file synchronization commands are capa7le ofsynchronizin$ h0$e file systems containin$ millions of files very effectively while 0sin$a very small amo0nt of system memory and " reso0rces.

Server& o&Server ile Sync roni ation Co))and ' this command cansynchronize files directly 7etween two IronSync Servers witho0t 0sin$ networ sharesand optionally compress and encrypt transferred data 7loc s. Server'To'Server filesynchronization commands provide m0ltiple one'way and two'way file synchronizationmodes9 compressed and encrypted file synchronization capa7ilities9 periodic filesynchronization capa7ilities9 r0le'7ased file synchronization capa7ilities9 error lo$s9 /'4ail notifications9 etc. -ll file sync actions are performed on'the'fly9 witho0t readin$ orwritin$ any file system state files or data7ases and therefore server'to'server filesynchronization commands are capa7le of synchronizin$ h0$e file systems containin$millions of files very effectively while 0sin$ a very small amo0nt of system memoryand " reso0rces.

eal& i)e ile Sync roni ation Co))and ' this command synchronizes chan$edfiles on'the'fly as files are chan$in$ in the so0rce directory. IronSync Server monitorsthe so0rce directory9 detects individ0al file chan$es and synchronizes all chan$ed filesto the destination directory. File synchronization is performed in one direction only 'from the so0rce directory to the destination directory. So0rce and destinationdirectories are never scanned and this type of file synchronization commands isespecially optimized for effective synchronization of h0$e file systems containin$ tensand h0ndreds of millions of files.

eal& i)e irectory Sync roni ation Co))and ' this command synchronizeschan$ed directories on'the'fly as files are chan$in$ in the so0rce directory. IronSyncServer monitors the so0rce directory9 in real'time detects chan$ed s07directories andperforms short sync operations 7etween s07directories. The 0ser is provided with fivedifferent one'way and two'way file synchronization modes. F0ll scannin$ of the so0rceand destination directories is never performed9 file synchronization is completed in

real'time 7etween pairs of chan$ed s07directories and this type of file synchronizationcommands is optimized for effective synchronization of h0$e file systems containin$tens and h0ndreds of millions of files.


7/40


#

3.2 Periodic ile Sync roni ation Co))ands

"eriodic file synchronization commands provide m0ltiple one'way and two'way filesynchronization modes9 r0le'7ased file synchronization capa7ilities9 file synchronization lo$s9error /'4ail notifications9 etc. "eriodic file sync commands may 7e exec0ted man0ally ora0tomatically tri$$ered 0sin$ one or more daily9 wee ly or monthly periodic sync tri$$ers.

/very time a periodic file sync command is tri$$ered9 IronSync rescans the so0rce anddestination directories and synchronizes all chan$ed files accordin$ to the selected filesynchronization mode. -ll sync actions are performed on'the'fly9 witho0t readin$ or writin$any file system state files or data7ases and therefore periodic file synchronization commandsare capa7le of synchronizin$ h0$e file systems containin$ millions of files very effectively while0sin$ a very small amo0nt of system memory and " reso0rces.

"eriodic file synchronization commands provide m0ltiple one'way and two'way filesynchronization modes with each one desi$ned for specific needs and 0sa$e scenarios. Inorder to chan$e the file synchronization mode for a periodic file synchronization command9open the command options dialo$ and select an appropriate file synchronization mode."eriodic file synchronization commands provide the followin$ file synchronization modes

Sync roni e estination irectory :one'way< ' -ll chan$es made in the so0rcedirectory will 7e propa$ated to the destination directory. Files deleted from the so0rcedirectory will 7e deleted from the destination directory. -ll files chan$ed or deleted inthe destination directory will 7e restored 0sin$ files from the so0rce directory. ochan$es will 7e made in the so0rce directory. -fter the file synchronization process iscomplete 7oth locations will 7e identical.

U"date estination irectory :one'way< ' ewly created and modified so0rce fileswill 7e copied to the destination directory. Files deleted from the so0rce directory will7e deleted from the destination directory. Files deleted from the destination directory

will 7e restored 0sin$ files from the so0rce directory. ewly created and modifieddestination files will 7e ept in place. o chan$es will 7e made in the so0rce directory. !ccu)ulate and U"date iles in estination :one'way< ' ewly created and

modified so0rce files will 7e copied to the destination directory. Files deleted from thedestination directory will 7e restored 0sin$ files from the so0rce directory. ewlycreated and modified destination files will 7e ept in place. o files will 7e deletedfrom the destination directory. o chan$es will 7e made in the so0rce directory.

wo&$ay ile Sync roni ation ' ewly created and modified files will 7esynchronized in 7oth directions. Files deleted from the so0rce directory will 7e deletedfrom the destination directory. Files deleted from the destination directory will 7erestored from the so0rce directory. han$es may 7e made in 7oth locations. -fter thefile synchronization process is complete 7oth locations will 7e identical.

wo&$ay !ccu)ulation and U"date ' ewly created and modified files will 7e0pdated in 7oth directions. Files deleted from one location will 7e restored from thesecond location. han$es may 7e made in 7oth locations. -fter the file synchronizationprocess is complete 7oth locations will 7e identical.


8/40


%

3.3 Periodic ile Sync roni ation riggers

"eriodic file synchronization commands may 7e a0tomatically tri$$ered 0sin$ one or moreperiodic9 daily9 wee ly or monthly sync tri$$ers. In order to confi$0re sync tri$$ers for aperiodic file synchronization command9 open the command options dialo$ and select theB=eneralB ta7. The B=eneralB ta7 shows the c0rrently confi$0red sync tri$$ers and allows one to

add9 delete9 ena7le9 disa7le and confi$0re an 0nlimited n0m7er of sync tri$$ers.

In order to add a new sync tri$$er for a periodic file synchronization command9 press the B-ddTri$$erB 70tton9 select a tri$$er type9 specify all the re?0ired parameters and press the B B70tton. In order to chan$e a previo0sly confi$0red sync tri$$er9 select the sync tri$$er in thetri$$ers view9 press the ri$ht mo0se 70tton and select the B/dit Tri$$erB men0 item.

Simple periodic sync tri$$ers provide the a7ility to exec0te a sync command every C min0tesor ho0rs. ,aily tri$$ers provide the a7ility to exec0te a sync command every day at a specifiedtime. In order to exec0te a sync command twice per day at different times9 the 0ser can addtwo daily tri$$ers with each one confi$0red to tri$$er the sync command at a different time.

6ee ly tri$$ers provide the a7ility to specify days of the wee and a time of the day toexec0te the sync command. 40ltiple wee ly tri$$ers may 7e 0sed to exec0te the synccommand at different times on different wee days. In addition9 0sers are provided withmonthly sync tri$$ers allowin$ one to exec0te a sync command on specific days of month.Finally9 IronSync provides a sin$le time sync tri$$er allowin$ one to exec0te a sync commandone time only at a specified date and time.


9/40


(

3.4 Server& o&Server ile Sync roni ation Co))ands

Server'to'Server file synchronization commands can synchronize files directly 7etween twoIronSync Servers witho0t 0sin$ networ shares and optionally compress and encrypttransferred data 7loc s. Server'To'Server file synchronization commands provide m0ltipleone'way and two'way file synchronization modes9 compressed and encrypted file

synchronization capa7ilities9 r0le'7ased file synchronization capa7ilities9 file synchronizationlo$s9 error /'4ail notifications9 etc. "eriodic file sync commands may 7e exec0ted man0ally ora0tomatically tri$$ered 0sin$ one or more daily9 wee ly or monthly periodic sync tri$$ers.

Server'To'Server file synchronization commands provide m0ltiple one'way and two'way filesynchronization modes with each one desi$ned for specific needs and 0sa$e scenarios. Inorder to chan$e the file synchronization mode for a periodic file synchronization command9open the command options dialo$ and select an appropriate file synchronization mode.

Server'To'Server file synchronization commands provide the followin$ additional options

Veri(y rans(erred ata 'loc5s ' when this option is ena7led IronSync Server

verifies the S5-2)! hash si$nat0re for each transferred data 7loc and a0tomaticallyretransmits all corr0pted data 7loc s.

Co)"ress rans(erred ata 'loc5s ' when this option is ena7led IronSync Servercompresses each transferred data 7loc th0s minimizin$ the amo0nt of datatransferred thro0$h the networ .

6ncry"t rans(erred ata 'loc5s ' when this option is ena7led IronSync Serverencrypts each transferred data 7loc 0sin$ the -/S'2)! encryption al$orithm withdynamically chan$ed encryption eys.

/very time a periodic file sync command is tri$$ered9 IronSync rescans the so0rce anddestination directories and synchronizes all chan$ed files accordin$ to the selected filesynchronization mode. -ll sync actions are performed on'the'fly9 witho0t readin$ or writin$

any file system state files or data7ases and therefore periodic file synchronization commandsare capa7le of synchronizin$ h0$e file systems containin$ millions of files very effectively while0sin$ a very small amo0nt of system memory and " reso0rces.


10/40


1+

3.# eal& i)e ile Sync roni ation Co))ands

*eal'Time file synchronization commands synchronize chan$ed files on'the'fly as files arechan$in$ in the so0rce directory. IronSync Server monitors the so0rce directory9 detectsindivid0al file chan$es and synchronizes all chan$ed files to the destination directory. Filesynchronization is performed in one direction only ' from the so0rce directory to the

destination directory. So0rce and destination directories are never scanned and this type offile synchronization commands is especially optimized for effective synchronization of h0$e filesystems containin$ tens and h0ndreds of millions of files.

In order to add a real'time file synchronization command9 press the B-ddB 70tton located onthe main tool7ar9 select the B*eal'Time File SynchronizationB command type9 enter a 0ni?0ecommand name9 specify the so0rce and destination directories and press the BSaveB 70tton.

*eal'Time file synchronization commands can 7e started man0ally or a0tomatically when thecomp0ter starts. In order to ena7le a0to start for a real'time file synchronization command9select the command in the commands view9 press the ri$ht mo0se 70tton9 select the B/ditommandB men0 item9 select the B=eneralB ta7 and select the B-0to StartB command option.

- real'time file synchronization command may 7e confi$0red to synchronize specific types offiles or file $ro0ps 0sin$ flexi7le file matchin$ r0les. In order to add one or more file matchin$r0les to a real'time file synchronization command9 open the command options dialo$9 selectthe B*0lesB ta79 press the B-ddB 70tton and select an appropriate r0le type. For example9 the0ser is provided with the a7ility to sync all types of doc0ments with the file size more than C4; and>or a text pattern in the file name.


11/40


11

3., eal& i)e irectory Sync roni ation Co))ands

*eal'Time directory synchronization commands synchronize chan$ed directories on'the'fly asfiles are chan$in$ in the so0rce directory. IronSync Server monitors the so0rce directory9 inreal'time detects chan$ed s07directories and performs short sync operations 7etweens07directories witho0t scannin$ the complete directory tree. The 0ser is provided with five

different one'way and two'way file synchronization modes. F0ll scannin$ of the so0rce anddestination directories is never performed and file synchronization is completed in real'time7etween pairs of chan$ed s07directories.

In order to chan$e the file synchronization mode for a file synchronization command9 open thefile synchronization command options dialo$ and select one of the followin$ filesynchronization modes


U"date estination irectory :one'way< ' ewly created and modified so0rce fileswill 7e copied to the destination directory. Files deleted from the so0rce directory will7e deleted from the destination directory. Files deleted from the destination directorywill 7e restored 0sin$ files from the so0rce directory. ewly created and modifieddestination files will 7e ept in place. o chan$es will 7e made in the so0rce directory.

!ccu)ulate and U"date iles in estination :one'way< ' ewly created and

modified so0rce files will 7e copied to the destination directory. Files deleted from thedestination directory will 7e restored 0sin$ files from the so0rce directory. ewlycreated and modified destination files will 7e ept in place. o files will 7e deletedfrom the destination directory. o chan$es will 7e made in the so0rce directory.




12/40


12

3.- !dvanced ile Sync roni ation O"tions

IronSync provides a lar$e n0m7er of advanced file synchronization options allowin$ one toc0stomize file synchronization operations for 0ser'specific needs and hardware confi$0rations.In order to open the file synchronization options dialo$9 select a file synchronization commandin the sync commands view9 press the ri$ht mo0se 70tton and select the B/dit ommandB

men0 item.

The B!dvanced B ta7 allows one to control the n0m7er of parallel file synchronization threads9the n0m7er of parallel directory scannin$ threads9 the performance mode and the filesynchronization preview mode9 which may 7e 0sed to test advanced file synchronizationoptions 7efore exec0tin$ file synchronization operations on prod0ction data.

The BO"tions B ta7 provides the a7ility to control which meta data is synchronized when filesare copied from one directory to another. In addition9 the 0ser is provided with the a7ility toena7le the 7it'level file synchronization option for any file synchronization command. 6ith thisoption ena7led9 IronSync Server will compare and 0pdate individ0al data 7loc s in files thatsho0ld 7e synchronized th0s minimizin$ the amo0nt of data written to the dis . Finally9IronSync Server provides the a7ility to verify the inte$rity of copied files 7y comparin$ hashsi$nat0res of so0rce and destination files after each file copy operation.


13/40


13

3.+ Sync roni ing S"eci(ic y"es o( iles

Sometimes9 it may 7e re?0ired to synchronize specific types of files or $ro0ps of filesaccordin$ to 0ser'specific needs and re?0irements. IronSync provides a lar$e set of filematchin$ r0les allowin$ one to synchronize files 7y the file type9 extension9 size9 file name9directory9 attri70tes9 0ser name9 etc. The 0ser is provided with the a7ility to add a n0m7er of

file matchin$ r0les to any file synchronization operation specifyin$ which files to synchronize.

For example9 IronSync allows one to synchronize all types of doc0ment files with the file sizemore than C 4; and a text pattern in the file name. The 0ser is provided with the a7ility tocom7ine different types of file matchin$ r0les and lo$ical operators precisely selectin$ filesthat sho0ld 7e synchronized.

In addition to positive file matchin$ r0les9 the 0ser is provided with ne$ative file matchin$r0les9 which can 7e 0sed to excl0de specific types or $ro0ps of files from the filesynchronization process. For example9 IronSync allows one to excl0de all types of ima$esowned 7y a specific 0ser and havin$ the system file attri70te. 8ario0s types of positive andne$ative file matchin$ r0les may 7e com7ined into sophisticated9 m0lti'level file filtersprecisely selectin$ which files to synchronize and which files to excl0de from the filesynchronization process.


14/40


1&

3.7 68cluding irectories ro) ile Sync roni ation

Sometimes9 it may 7e re?0ired to excl0de one or more s07directories from the filesynchronization process. For example9 if yo0 need to synchronize two directories excl0din$one or two special s07directories9 yo0 may specify the top level directories as the so0rce anddestination directories and add the s07directories that sho0ld 7e s ipped to the excl0de list.

In order to add one or more directories to the excl0de list9 open the file synchronizationcommand options dialo$9 select the B/xcl0deB ta7 and add one or more directories to theexcl0de directories list. -ll files and s07directories located in the specified excl0de directorieswill 7e excl0ded from the file synchronization process.

In addition9 advanced 0sers are provided with a n0m7er of excl0de directories macro

commands allowin$ one to excl0de m0ltiple directories 0sin$ a sin$le macro command.IronSync Server provides the followin$ excl0de directories macro commands

9'6 I:S ; e8t String< ' this macro command excl0des all directories 7e$innin$with the specified text strin$.

9CO: !I:S ; e8t String< ' this macro command excl0des all directoriescontainin$ the specified text strin$.

96: S ; e8t String< ' this macro command excl0des all directories endin$ with thespecified text strin$.

9 6 6= ; egular 68"ression< ' this macro command excl0des directoriesmatchin$ the specified re$0lar expression.

For example9 the excl0de macro command BD T-I S Temporary FilesB will excl0de alldirectories with BTemporary FilesB at any place in the f0ll directory path and the excl0de macrocommand BD*/=/C E.:T4" T/4"


15/40


1)

3.10 ile Sync roni ation *ogs and 6rror :oti(ications

IronSync provides a n0m7er of file synchronization lo$s and error notification options allowin$one to eep file synchronization operations 0nder control. In order to ena7le error /'4ailnotifications for a file synchronization command9 open the file synchronization commanddialo$9 select the B4iscB ta79 select the BSend /rror otificationsB option and specify an /'4ail

address to send error notifications to. In addition9 in order to ena7le /'4ail notifications9 the0ser needs to open the B ptionsB dialo$9 select the B/'4ailB ta7 and specify an S4T" server to0se to send /'4ail notifications.

/rror /'4ail notifications are sent when a file synchronization operation is a7orted d0e to acritical error s0ch as no dis space on the destination device or when there are too many non'critical errors. In addition to error /'4ail notifications9 the 0ser is provided with the a7ility tosave file synchronization error lo$s in a 0ser'specified directory. Finally9 in order to simplifytestin$ of sophisticated file synchronization operations9 IronSync provides the a7ility to savef0ll file synchronization lo$s incl0din$ all file synchronization actions performed 7y a filesynchronization operation.

File synchronization lo$s and error notifications may 7e ena7led for each file synchronizationcommand individ0ally and $lo7ally for all file synchronization commands on the IronSyncServer B ptionsB dialo$. File synchronization lo$s and error notifications options specified for a

file synchronization command ta e precedence over $lo7al file synchronization lo$s and errornotification options specified on the IronSync Server B ptionsB dialo$.


16/40


17/40


18/40


1%

3.13 Con(iguring IronSync Server

IronSync Server provides a lar$e n0m7er of advanced confi$0ration options allowin$ one toc0stomize the prod0ct for 0ser'specific needs and re?0irements. In order to open the B ptionsBdialo$9 open the IronSync client = I application9 connect to a server and press the B ptionsB70tton located on the main tool7ar. 6hen the 0ser opens the B ptionsB dialo$9 the client = I

application re?0ests server confi$0ration options from the IronSync Server and 0pdatesconfi$0ration options on the server side when the 0ser closes the B ptionsB dialo$.

The B eneral B ta7 provides a lar$e n0m7er of $eneral'p0rpose options allowin$ one to controlhow IronSync scans directories9 handles errors and reports a7o0t different types of filesynchronization errors. The BServerB ta7 provides the a7ility to c0stomize the IronSync Server0ser name and password 0sed 7y the IronSync client = I application and the command line0tility to lo$in to the IronSync Server. ;y defa0lt9 IronSync Server is confi$0red to 0se the

Bad)in>ad)in B 0ser name and password9 which can 7e chan$ed to any ar7itrary 0ser nameand password.

In order to prevent 0na0thorized access to the IronSync Server9 all comm0nication 7etweenthe client = I application and the IronSync server is performed 0sin$ an -/S'2)! encryptednetwor protocol with randomly selected and dynamically chan$ed eys for each session. Inaddition9 the BServerB ta7 provides the a7ility to c0stomize the server control port 0sed 7y theIronSync client = I application and the command line 0tility to connect to the server. Finally9the 0ser is provided with the a7ility to c0stomize the we7 mana$ement interface port 0sed 7ywe7 7rowsers to connect to the IronSync server. If the IronSync server sho0ld 7e controlledvia the networ 9 one or 7oth of these ports sho0ld 7e open in the serverBs firewall.


19/40


1(

The B!dvanced B ta7 allows one to control the maxim0m n0m7er of file synchronization errorsand the maxim0m n0m7er of consec0tive errors to a7ort a file synchronization operation. Inaddition9 the 0ser is provided with the a7ility to control the file copy verification mode9 specifya $lo7al file synchronization error lo$s directory9 a $lo7al sync lo$s directory and a $lo7al /'4ail address to send error notifications to.

If a $lo7al lo$ directory is specified9 IronSync Server will save error lo$s and>or sync lo$s forall file synchronization commands confi$0red in the IronSync Server. In addition to the $lo7allo$ directories9 the 0ser is provided with the a7ility to confi$0re lo$ directories for each filesynchronization command individ0ally on the file synchronization command options dialo$.

The B6&Mail B ta7 provides the a7ility to specify an S4T" server to 0se to send error /'4ailnotifications. If a $lo7al error notifications address is specified9 IronSync Server will send error/'4ail notifications to the $lo7al /'4ail address for all failed file synchronization operations. Inaddition9 to the $lo7al error notifications /'4ail address9 the 0ser is provided with the a7ility toconfi$0re an individ0al error notification /'4ail address for each file synchronization commandon the file synchronization command options dialo$.


20/40


2+

3.14 Product U"date Procedure

Flexense develops IronSync Server 0sin$ a fast release cycle with minor prod0ct versions90pdates and 70$ fixes released almost every month and maAor prod0ct versions releasedevery year. ew prod0ct versions and prod0ct 0pdates are p07lished on the prod0ct we7 siteand may 7e downloaded on the followin$ pa$e http >>www.ironsync.com>downloads.html .

,0e to the fact that the prod0ct is especially desi$ned for servers r0nnin$ in prod0ctionenvironments where sta7ility is a maAor decision factor9 IronSync Server 0pdates sho0ld 7eman0ally performed 7y the 0ser. In order to 0pdate an existin$ prod0ct installation9 downloadthe latest prod0ct version and A0st start the set0p pro$ram.

The IronSync Server set0p pro$ram will properly sh0tdown the r0nnin$ IronSync Server90pdate the prod0ct and restart the IronSync service after finishin$ the 0pdate proced0re. -llprod0ct confi$0ration files9 confi$0red file synchronization commands and prod0ct re$istrationwill remain valid and there is nothin$ to reconfi$0re or mana$e after the 0pdate.


21/40


21

3.1# Product egistration Procedure

6ithin a co0ple of ho0rs after p0rchasin$ a prod0ct license9 the c0stomer will receive two e'mail messa$es the first one confirmin$ the payment and the second one containin$ an 0nlocey9 which sho0ld 7e 0sed to re$ister the prod0ct. If yo0 will not receive yo0r 0nloc eywithin 2& ho0rs9 please chec yo0r spam 7ox and if the 0nloc ey is not in the spam 7ox

contact o0r s0pport team su""ort?(le8ense.co) .

If the comp0ter where the IronSync Server is installed on is connected to the Internet9connect to the IronSync Server 0sin$ the client = I application9 press the B*e$isterB 70ttonlocated in the top'ri$ht corner9 enter yo0r name or yo0r company name as the c0stomername9 enter the received 0nloc ey and press the B*e$isterB 70tton.

If the comp0ter is not connected to the Internet9 press the B4an0al *e$istrationB 70tton9export a prod0ct I, file and send the prod0ct I, file to register?ironsync.co) as anattachment. 6ithin a co0ple of ho0rs9 yo0 will receive an 0nloc file9 which sho0ld 7e importedin order to finish the re$istration proced0re.


22/40


22

4 Using $e%&'ased Inter(ace

IronSync Server provides a complete we7'7ased mana$ement interface allowin$ one tocontrol9 mana$e and confi$0re one or more IronSync servers locally or via the networ 0sin$ astandard we7 7rowser. ;y defa0lt9 the we7'7ased interface is disa7led and in order to ena7lethe we7'7ased mana$ement interface9 connect to the IronSync server 0sin$ the client = Iapplication9 open the B ptionsB dialo$9 select the BServerB ta79 select the B/na7le 6e7 ServerBoption and press the BSaveB 70tton.

In order to connect to the IronSync Server 0sin$ a re$0lar we7 7rowser9 enter the host nameor an I" address of the server in the address 7ar and lo$in 0sin$ the defa0lt 0ser name andpassword ad)in>ad)in . ;y defa0lt9 the we7'7ased mana$ement interface 0ses the T ">I"port %+9 which is the standard port 0sed 7y we7 7rowsers to connect to we7 servers9 and inorder to 7e a7le to mana$e the IronSync server via the networ 9 the we7 interface port sho0ld

7e open in the serverBs firewall.

The IronSync Server we7'7ased mana$ement interface is a dynamic we7 application9 which

shows the c0rrent stat0s of the server and the pro$ress of file synchronization operationswitho0t reloadin$ the c0rrently displayed we7 pa$e. In order to operate properly9 the we7'7ased interface re?0ires GavaScript to 7e ena7led in the we7 7rowser.


23/40


23

4.1 ile Sync roni ation Co))and y"es

IronSync Server provides m0ltiple different types of periodic and real'time file synchronizationcommands with each one optimized for different needs and 0sa$e scenarios. - specific filesynchronization command type sho0ld 7e selected for each newly created file synchronizationcommand. In order to add a new file synchronization command9 press the B-dd ommandB

70tton located on the IronSync Server home pa$e9 enter a command name and select anappropriate file synchronization command type.

IronSync Server provides the followin$ types of file synchronization commands

Periodic ile Sync roni ation Co))and ' this command may 7e exec0tedman0ally or a0tomatically tri$$ered 0sin$ one or more periodic9 daily9 wee ly ormonthly sync tri$$ers. "eriodic file synchronization commands provide m0ltiple one'way and two'way file synchronization modes9 r0le'7ased file synchronizationcapa7ilities9 error lo$s9 /'4ail notifications9 etc. /very time a periodic file synccommand is tri$$ered9 IronSync rescans the so0rce and destination directories andsynchronizes all chan$es accordin$ to the selected file synchronization mode. -ll sync

actions are performed on'the'fly9 witho0t readin$ or writin$ any file system state filesor data7ases and therefore periodic file synchronization commands are capa7le ofsynchronizin$ h0$e file systems containin$ millions of files very effectively while 0sin$a very small amo0nt of system memory and " reso0rces.

Server& o&Server ile Sync roni ation Co))and ' this command cansynchronize files directly 7etween two IronSync Servers witho0t 0sin$ networ sharesand optionally compress and encrypt transferred data 7loc s. Server'To'Server filesynchronization commands provide m0ltiple one'way and two'way file synchronizationmodes9 compressed and encrypted file synchronization capa7ilities9 periodic filesynchronization capa7ilities9 r0le'7ased file synchronization capa7ilities9 error lo$s9 /'4ail notifications9 etc. -ll file sync actions are performed on'the'fly9 witho0t readin$ orwritin$ any file system state files or data7ases and therefore server'to'server filesynchronization commands are capa7le of synchronizin$ h0$e file systems containin$millions of files very effectively while 0sin$ a very small amo0nt of system memoryand " reso0rces.

eal& i)e ile Sync roni ation Co))and ' this command synchronizes chan$edfiles on'the'fly as files are chan$in$ in the so0rce directory. IronSync Server monitorsthe so0rce directory9 detects individ0al file chan$es and synchronizes all chan$ed filesto the destination directory. File synchronization is performed in one direction only 'from the so0rce directory to the destination directory. So0rce and destinationdirectories are never scanned and this type of file synchronization commands isespecially optimized to effectively synchronize file systems with millions of files.

eal& i)e irectory Sync roni ation Co))and ' this command synchronizeschan$ed directories on'the'fly as files are chan$in$ in the so0rce directory. IronSyncServer monitors the so0rce directory9 in real'time detects chan$ed s07directories andperforms short sync operations 7etween s07directories. The 0ser is provided with fivedifferent one'way and two'way file synchronization modes. F0ll scannin$ of the so0rce

and destination directories is never performed9 file synchronization is completed inreal'time 7etween pairs of chan$ed s07directories and this type of file synchronizationcommands is optimized to effectively synchronize file systems with millions of files.


24/40


2&

4.2 Managing ile Sync roni ation Co))ands

IronSync Server allows one to set0p an 0nlimited n0m7er of file synchronization commandswith each one synchronizin$ files from a so0rce dis or directory to a destination dis ordirectory. In order to set0p one or more file synchronization commands9 lo$in to the IronSyncServer we7'7ased mana$ement console 0sin$ a standard we7 7rowser.

n the IronSync Server stat0s pa$e9 press the B-dd ommandB 70tton9 enter a 0ni?0ecommand name9 select an appropriate file synchronization command type9 enter a so0rcedirectory9 which sho0ld 7e a local dis or directory9 and enter a destination directory9 whichmay 7e set to a local dis 9 directory or a networ share9 and press the BSaveB 70tton.

In order to start a file synchronization command9 $o to the main stat0s pa$e and clic on theBStartB 70tton located on the ri$ht side of the file synchronization command. lic on thecommand name lin to see an extended stat0s of the command. In order to stop an active filesynchronization command9 clic on the BStopB lin located on the ri$ht side of the filesynchronization command.


25/40


26/40


2!

"eriodic file synchronization commands provide m0ltiple one'way and two'way filesynchronization modes with each one desi$ned for specific needs and 0sa$e scenarios. Inorder to chan$e the file synchronization mode for a periodic file synchronization command9open the command B/ditB pa$e and select an appropriate file synchronization mode.

"eriodic file synchronization commands s0pport the followin$ file synchronization modes


U"date estination irectory :one'way< ' ewly created and modified so0rce fileswill 7e copied to the destination directory. Files deleted from the so0rce directory will7e deleted from the destination directory. Files deleted from the destination directorywill 7e restored 0sin$ files from the so0rce directory. ewly created and modifieddestination files will 7e ept in place. o chan$es will 7e made in the so0rce directory.

!ccu)ulate and U"date iles in estination :one'way< ' ewly created andmodified so0rce files will 7e copied to the destination directory. Files deleted from thedestination directory will 7e restored 0sin$ files from the so0rce directory. ewly

created and modified destination files will 7e ept in place. o files will 7e deletedfrom the destination directory. o chan$es will 7e made in the so0rce directory. wo&$ay ile Sync roni ation ' ewly created and modified files will 7e

synchronized in 7oth directions. Files deleted from the so0rce directory will 7e deletedfrom the destination directory. Files deleted from the destination directory will 7erestored from the so0rce directory. han$es may 7e made in 7oth locations. -fter thefile synchronization process is complete 7oth locations will 7e identical.



27/40


2#

"eriodic file synchronization commands may 7e a0tomatically tri$$ered 0sin$ one or moreperiodic9 daily9 wee ly or monthly sync tri$$ers. In order to confi$0re sync tri$$ers for aperiodic file synchronization command9 open the command B/ditB pa$e and press the BTri$$ersB70tton. The BSync Tri$$ersB pa$e shows the c0rrently confi$0red sync tri$$ers and allows oneto add9 delete9 ena7le9 disa7le and confi$0re an 0nlimited n0m7er of sync tri$$ers.

In order to add a new sync tri$$er for a periodic file synchronization command9 press the B-ddTri$$erB 70tton9 select a tri$$er type9 specify all the re?0ired parameters and press the B-ddB70tton. In order to chan$e a previo0sly confi$0red sync tri$$er9 clic on the tri$$erBs B/ditB70tton located in the BToolsB col0mn.

Simple periodic sync tri$$ers provide the a7ility to exec0te a sync command every C min0tesor ho0rs. ,aily sync tri$$ers provide the a7ility to exec0te a sync command every day at aspecified time. In order to exec0te a sync command twice per day at different times9 the 0sercan add two daily tri$$ers with each one confi$0red to tri$$er the sync command at a differenttime. 6ee ly tri$$ers provide the a7ility to specify days of wee :from 1 to # delimited 7y thecomma character< and a time of the day to exec0te the sync command. 40ltiple wee lytri$$ers may 7e 0sed to exec0te the sync command at different times on different wee days.In addition9 0sers are provided with monthly sync tri$$ers allowin$ one to exec0te a synccommand on specific days of month. Finally9 IronSync provides a sin$le time sync tri$$erallowin$ one to exec0te a sync command one time only at a specified date and time.


28/40


2%

4.4 eal& i)e irectory Sync roni ation Co))ands

*eal'Time directory synchronization commands synchronize chan$ed directories on'the'fly asfiles are chan$in$ in the so0rce directory. IronSync Server monitors the so0rce directory9 inreal'time detects chan$ed s07directories and performs short sync operations 7etweens07directories witho0t scannin$ the complete directory tree. The 0ser is provided with five

different one'way and two'way file synchronization modes. F0ll scannin$ of the so0rce anddestination directories is never performed and file synchronization is completed in real'time7etween pairs of chan$ed s07directories.

In order to chan$e the file synchronization mode for a file synchronization command9 open thefile synchronization command confi$0ration pa$e and select one of the followin$ filesynchronization modes


U"date estination irectory :one'way< ' ewly created and modified so0rce fileswill 7e copied to the destination directory. Files deleted from the so0rce directory will7e deleted from the destination directory. Files deleted from the destination directory

will 7e restored 0sin$ files from the so0rce directory. ewly created and modifieddestination files will 7e ept in place. o chan$es will 7e made in the so0rce directory.

!ccu)ulate and U"date iles in estination :one'way< ' ewly created andmodified so0rce files will 7e copied to the destination directory. Files deleted from thedestination directory will 7e restored 0sin$ files from the so0rce directory. ewlycreated and modified destination files will 7e ept in place. o files will 7e deletedfrom the destination directory. o chan$es will 7e made in the so0rce directory.




29/40


2(

4.# !dvanced ile Sync roni ation Co))ands O"tions

In order to access advanced file synchronization command options9 clic on the B/ditommandB 70tton located on the ri$ht side of the file synchronization command and press theB-dvanced ptionsB 70tton. The advanced options pa$e allows one to specify one or moreexcl0de directories9 set the n0m7er of file synchronization streams to 0se for the command9

set0p a c0stom error lo$s directory to save error reports and>or send /'4ail notifications whenthe command is a7orted d0e to a hardware pro7lem.

-nother very 0sef0l feat0re is the sync preview mode9 which may 7e ena7led for any filesynchronization command on the advanced options pa$e. In the preview mode9 IronSync willmonitor the so0rce directory9 examine all detected file system chan$es and calc0late theexpected chan$e rate witho0t performin$ any actions in the destination directory. This modeallows one to analyze a fre?0ently chan$in$ file system and estimate expected performancere?0irements in order to properly select a fast eno0$h 7ac 0p device to 7e 0sed as adestination directory for a file synchronization command.

IronSync Server provides the a7ility to perform initial file synchronization for static filesexisted in the so0rce directory 7efore the file synchronization command was started for thefirst time. In order to ena7le initial file synchronization for a sync command9 open the main

command pa$e and select the B/na7le Initial File SynchronizationB option. ;y defa0lt9 initial filesynchronization is performed when the IronSync server is idle9 pa0sed when a lar$e n0m7er ofreal'time sync actions sho0ld 7e performed and a0tomatically res0med when the n0m7er ofpendin$ sync actions drops 7elow a 0ser'confi$0ra7le limit.

The BInitial Sync Start LimitB option sets the n0m7er of pendin$ file system chan$es or pendin$sync actions tri$$erin$ the start of the initial file synchronization operation. The BInitial SyncStop LimitB option sets the n0m7er of pendin$ file system chan$es or pendin$ sync actionstri$$erin$ the stop of the initial file synchronization operation. For example9 when the n0m7erof pendin$ sync actions drops 7elow the start limit9 the initial file sync operation is res0medand when the n0m7er of pendin$ actions raises a7ove the stop limit9 the initial sync operationis pa0sed.


30/40


3+

4., Sync roni ing S"eci(ic y"es o( iles

Sometimes9 it may 7e re?0ired to synchronize files related to a specific file type or cate$oryaccordin$ to 0ser'specific needs while s ippin$ all other files. IronSync Server allows one tospecify which types of files sho0ld 7e synchronized 7y a file synchronization command. The0ser is provided with the a7ility to synchronize files 7y the file name9 extension9 directory9 file

type9 size9 text or 7inary patterns9 etc.

For example9 IronSync Server allows one confi$0re a file synchronization command to sync alltypes of doc0ments with the file size more than 1+ 4; and the file name 7e$innin$ withBI* SH B while s ippin$ all other files not matchin$ the specified r0les. In order to confi$0re

file matchin$ r0les for a command9 open the command pa$e and press the B*0lesB 70tton. nthe B*0lesB pa$e press the B-dd *0leB 70tton9 select an appropriate r0le type9 operator9 a r0leval0e and press the BSaveB 70tton.

IronSync Server allows one to add an 0nlimited n0m7er of file matchin$ r0les for each filesynchronization command with each one confi$0red to match files 7y a specific file property.In addition9 advanced 0sers are provided with the a7ility confi$0re an 0nlimited n0m7er ofhierarchical nested r0les com7ined with lo$ical operators and allowin$ one to precisely selecttypes of files that sho0ld 7e synchronized.


31/40


31

4.- ile Sync roni ation O"tions

-dditional file synchronization options may 7e controlled on the BFile Sync ptionsB pa$e. Inorder to open the file synchronization options pa$e open the file synchronization commandpa$e and press the B ptionsB 70tton.

Sync ile !ttri%utes ' select this option if yo0 wish to sync file attri70tes for all files

copied from the so0rce to the destination directory :7y defa0lt this option is ena7led rou" Security escri"tor ' select this option if yo0 wish to copy file

ownership information for all files copied from the so0rce to the destination directory:7y defa0lt this option is disa7led


32/40


33/40


33

4.7 Con(iguring IronSync Server

IronSync Server provides a variety of confi$0ration options allowin$ one to easily inte$rate theprod0ct into a 0ser'specific networ environment. In order to open the main settin$s pa$e9clic on the BSettin$sB lin located on the top men0 7ar.

4.10 Con(iguring User :a)e and Password

The IronSync Server we7'7ased mana$ement console9 re?0ires 0sers to lo$in with a IronSync0ser name and password. The defa0lt 0ser name and password is set to ad)in >ad)in . In

addition9 IronSync Server provides the a7ility to set a c0stom 0ser name and>or password forthe IronSync we7'7ased mana$ement interface and the command line 0tility9 which may 7e0sed to a0tomate confi$0ration and mana$ement tas s.

In order to set a c0stom 0ser name and password9 clic on the B onfi$0re Server Lo$inB linlocated on the main settin$s pa$e9 enter a new 0ser name and password and press the BSaveB70tton.


34/40


3&

4.11 Con(iguring 6rror Bandling O"tions

IronSync Server provides a n0m7er of advanced error handin$9 recovery and notificationoptions. In order to open the error handlin$ pa$e9 $o to the main settin$s pa$e and clic onthe BLo$s and otificationsB lin .

,efa0lt error handlin$ settin$s sho0ld 7e $ood eno0$h for most 0sers9 70t if re?0ired9 the 0seris provided with the a7ility to c0stomize the maxim0m n0m7er of errors per sync command9the maxim0m n0m7er of consec0tive errors9 the maxim0m n0m7er of retries to perform foreach loc ed file and the initial retry delay.

In addition9 IronSync Server provides the a7ility to set a $lo7al lo$s directory and>or a $lo7alnotification /'4ail address to send notifications a7o0t failed file synchronization commands. Ifthe $lo7al lo$s directory and>or error notifications are ena7led9 IronSync will save error lo$sand>or send notifications for all failed file synchronization commands. File synchronizationcommands explicitly confi$0red to save error lo$s to a different directory and>or sendnotifications to a different /'4ail address ta e precedence over the $lo7al settin$s.


35/40


3)

4.12 Con(iguring Server Control and $e% !ccess Ports

IronSync Server 0ses the T ">I" port (1&2 as the defa0lt server control port and the T ">I"port %+ as the defa0lt we7 access port. Sometimes9 these ports may 7e in 0se 7y some othersoftware prod0cts or system services. If one or 7oth of these ports are in 0se9 IronSync will 7e0na7le to operate properly and the 0ser needs to chan$e the IronSync server control port

and>or we7 access port.

In order to set a c0stom server control port and>or we7 access port9 clic on the BSet0p Server"ortsB lin located on the main settin$s pa$e9 select the B se 0stom "ortB option and enter ac0stom port n0m7er to 0se. If the IronSync server sho0ld 7e controlled thro0$h the networ 9ma e s0re the c0stom ports are open in the serverBs firewall.

4.13 Con(iguring 6&Mail :oti(ications

IronSync Server provides the a7ility to send /'4ail notifications when a file synchronizationcommand fails d0e to a hardware pro7lem. In order to confi$0re an S4T" /'4ail server to 0seto send /'4ail notifications9 clic on the B onfi$0re /'4ail ServerB lin located on the mainsettin$s pa$e9 enter the S4T" server host name9 S4T" server port9 S4T" 0ser name9password and the so0rce /'4ail address to 0se to send /'4ail notifications.


36/40


3!

4.14 Product egistration Procedure

6ithin a co0ple of ho0rs after p0rchasin$ a prod0ct license9 the c0stomer will receive two e'mail messa$es the first one confirmin$ the payment and the second one containin$ an 0nlocey9 which sho0ld 7e 0sed to re$ister the prod0ct. If yo0 will not receive yo0r 0nloc eywithin 2& ho0rs9 please chec yo0r spam 7ox and if the 0nloc ey is not in the spam 7ox

contact o0r s0pport team su""ort?(le8ense.co) .

If the comp0ter where IronSync Server is installed on is connected to the Internet9 lo$in to theIronSync we7'7ased mana$ement interface :defa0lt 0ser name and password ad)in >ad)in 44>,,'t K55 44

ironsync &co))andDena%leDtrigger ;Co))and :a)e< &id ; rigger I

IronSync Server Manual v2.4

Documents

Transcript of IronSync Server Manual v2.4