Lsyncd (Live Syncing Daemon) synchronizes local directories with remote targets
Go to file
Daniel Poelzleithner f02bf700c1 bump version to 2.3.0 2022-06-07 23:26:04 +02:00
.github/workflows don't fail fast in CI 2022-06-07 22:30:51 +02:00
cmake change header discription 2022-02-24 14:40:46 +01:00
docs Document crontab support 2022-06-03 06:45:38 +02:00
examples Add rsync tunnel example 2022-06-03 06:45:38 +02:00
m4 Try harder to find matching Lua program/library pairs 2012-10-02 15:58:52 +02:00
tests Add proper compatibilty wrappers for 5.1 2022-06-07 22:28:30 +02:00
.editorconfig add .editorconfig 2022-03-11 07:12:39 +01:00
.gitignore move docs from gh-pages into src folder to keep it easier in sync 2022-04-20 19:20:52 +02:00
CMakeLists.txt bump version to 2.3.0 2022-06-07 23:26:04 +02:00
COPYING Fix documentation spelling bits, and a few links 2013-05-04 13:11:09 +10:00
ChangeLog Document crontab support 2022-06-03 06:45:38 +02:00
INSTALL preparing 2.2.3 2018-03-09 10:08:21 +01:00
README.md fix manual link 2022-04-20 23:16:44 +02:00
bin2carray.lua fix script integration 2011-05-04 13:18:37 +00:00
config.h.in Remove /System/Volumes/Data from fsevent paths on macOS 2020-09-25 15:36:25 -04:00
default-direct.lua Finish full sync cron trigger 2022-06-03 06:45:38 +02:00
default-rsync.lua Implement batchSizeLimit for rsync based transfers 2022-06-03 06:45:38 +02:00
default-rsyncssh.lua Merge remote-tracking branch 'origin/pr/583' 2021-12-06 20:31:12 +01:00
default.lua Finish full sync cron trigger 2022-06-03 06:45:38 +02:00
distclean.sh adding a distclean script 2016-12-13 14:56:23 +01:00
flake.lock Add lua-crontab to dependencies 2022-06-03 06:43:43 +02:00
flake.nix Add lua-crontab to dependencies 2022-06-03 06:43:43 +02:00
fsevents.c Remove /System/Volumes/Data from fsevent paths on macOS 2020-09-25 15:36:25 -04:00
inotify.c cleanups 2018-03-09 15:41:16 +01:00
lsyncd.c lua 5.4 fixes 2022-06-03 07:07:08 +02:00
lsyncd.h add onepass option to exit after initial sync 2018-12-05 17:05:18 +11:00
lsyncd.lua bump version to 2.3.0 2022-06-07 23:26:04 +02: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 achieved. See the manual for details.

Lsyncd 2.2.1 requires rsync >= 3.1 on all source and target machines.

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.

Mirror is an asynchronous synchronisation tool that takes use of the inotify notifications much like Lsyncd. The main differences are: it is developed specifically for master-master use, thus running on a daemon on both systems, uses its own transportation layer instead of rsync and is Java instead of Lsyncd's C core with Lua scripting.

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 manual.

Disclaimer

Besides the usual disclaimer in the license, we want to specifically emphasize that the authors, and any organizations the authors are associated with, can not be held responsible for data-loss caused by possible malfunctions of Lsyncd.