Lsyncd (Live Syncing Daemon) synchronizes local directories with remote targets
Go to file
Axel Kittenberger b6228f442d Replacing autotools with CMake 2014-04-29 16:11:27 +02:00
cmake Replacing autotools with CMake 2014-04-29 16:11:27 +02:00
doc Fix documentation spelling bits, and a few links 2013-05-04 13:11:09 +10:00
examples Add missed comma. 2014-01-03 17:11:48 +09:00
m4 Try harder to find matching Lua program/library pairs 2012-10-02 15:58:52 +02:00
tests beautified some tests 2012-11-23 16:04:43 +01:00
.gitignore Replacing autotools with CMake 2014-04-29 16:11:27 +02:00
CMakeLists.txt Replacing autotools with CMake 2014-04-29 16:11:27 +02:00
COPYING Fix documentation spelling bits, and a few links 2013-05-04 13:11:09 +10:00
ChangeLog updating changelog 2014-04-24 13:33:07 +02:00
INSTALL Replacing autotools with CMake 2014-04-29 16:11:27 +02:00
README.md Update README link to latest official home 2013-08-07 13:34:52 +10:00
autogen.sh coded a lua hello world 2010-10-14 13:52:01 +00:00
bin2carray.lua fix script integration 2011-05-04 13:18:37 +00:00
config.h.in Replacing autotools with CMake 2014-04-29 16:11:27 +02:00
default-direct.lua allow true, false, 'running' and 'startup' for the delete parameter 2012-10-09 17:47:39 +02:00
default-rsync.lua cosmetics 2014-02-28 10:15:48 +01:00
default-rsyncssh.lua adding ssh.identityFile and ssh.options options 2013-07-30 11:16:29 +02:00
default.lua Fix logging message 2013-09-30 23:05:59 +09:00
fsevents.c lock pidfile, remove pidfile on INT or TERM 2013-07-30 12:20:23 +02:00
inotify.c Replacing autotools with CMake 2014-04-29 16:11:27 +02:00
lsyncd.c Replacing autotools with CMake 2014-04-29 16:11:27 +02:00
lsyncd.h Replacing autotools with CMake 2014-04-29 16:11:27 +02:00
lsyncd.lua cosmetics 2014-02-28 10:15:48 +01:00

README.md

Lsyncd -- Live Syncing (Mirror) Daemon

Description

Lsyncd watches a local directory trees event monitor interface (inotify or fsevents). 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 block devices 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 re-transmitting the move destination over the wire.

Fine-grained customization 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 simple, powerful and flexible configurations can be acheived. See the manual for details Lsyncd21Manual

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 remotehost.org::share/

This watches and rsyncs the local directory /home with all sub-directories and transfers them to 'remotehost' using the rsync-share 'share'.

lsyncd -rsyncssh /home remotehost.org backup-home/

This will also rsync/watch '/home', but it uses a ssh connection to make moves local on the remotehost instead of re-transmitting the moved file over the wire.

Some more complicated examples, tips and tricks you can find in the Lsyncd21Manual.

Disclaimer

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.