Browse files

added markdown README

  • Loading branch information...
1 parent c7d11e4 commit 7388029c5e094aaa44a2f13f554405b0b0bcaa2a @axkibe axkibe committed Nov 16, 2011
Showing with 39 additions and 0 deletions.
  1. +39 −0
@@ -0,0 +1,39 @@
+Lsyncd -- Live Syncing (Mirror) Daemon
+Lsyncd watches a local directory trees event monitor interface (inotify). It aggregates and combines events for a few seconds and then spawns one (or more) process(es) to synchronize the changes. By default this is [rsync]( Lsyncd is thus a light-weight live mirror solution that is comparatively easy to install not requiring new filesystems or blockdevices and does not hamper local filesystem performance.
+Rsync+ssh is an advanced action configuration that uses a SSH to act file and directory moves directly on the target instead of retransmitting the move destination over the wire.
+Fine-grained customizaton can be achieved through the config file. Custom action configs can even be written from scratch in cascading layers ranging from shell scripts to code written in the [Lua language]( This way simplicity can be balanced with powerfulness. See the manual for details [Lsyncd20Manual](
+License: [GPLv2]( or any later GPL version.
+When to use
+Lsyncd is designed to synchronize a local directory tree with low profile of expected changes to a remote mirror. Lsyncd is especially useful to sync data from a secure area to a not-so-secure area.
+Other synchronization tools
+[DRBD]( operates on block device level. This makes it useful for synchronizing systems that are under heavy load. Lsyncd on the other hand does not require you to change block devices and/or mount points, allows you to change uid/gid of the transferred files, separates the receiver through the one-way nature of rsync. DRBD is likely the better option if you are syncing Databases.
+[GlusterFS]( and [BindFS]( use a FUSE-Filesystem to interject kernel/userspace filesystem events.
+Lsyncd usage examples
+```lsyncd -rsync /home```
+This watches and rsycn´s the local directory /home with all subdirectories and
+transfers them to 'remotehost' using the rsync-share 'share'.
+```lsyncd -rsyncssh /home backup-home/```
+This will also rsync/watch '/home', but it uses a ssh connection to make moves local on the remotehost instead of retransmitting the moved file over the wire.
+Some more complicated examples, tips and tricks you can find in the [Lsyncd20Manual](
+Besides the usual disclaimer in the license, we want to specifically emphasize that neither the authors nor any organization the authors are associated with can and will hold responsible for data-loss caused by possible malfunctions of Lsyncd.

0 comments on commit 7388029

Please sign in to comment.