Unison Runner is a tool to keep directories in sync using Unison. It shows up in the systray and show you the current synchronization status of your directories (up-to-date, syncing, offline, etc).

theMage 984372421f add version, some fixes 3 weeks ago
shots 8c4d3d7cbc add some more docs, including a menu shot 1 month ago
test 0774a5c0a4 add a small test script 1 month ago
.gitignore 97d092b05b initial commit 1 month ago
LICENSE 97d092b05b initial commit 1 month ago
README.md ab1a074c40 show defaults in doc/config and fix typo on doc 1 month ago
unison-runner.pl 984372421f add version, some fixes 3 weeks ago

README.md

unison-runner

Unison Runner is a tool to keep directories in sync using Unison. It shows up in the systray and show you the current synchronization status of your directories (up-to-date, syncing, offline, etc).

It doesn't handle any of the synchronization, that is left to unison, and it doesn't not try to be smart on how to use unison. It does very little.

It uses a config file, by default in ~/.config/unison-runner.cfg, but a different one can be passed with -c .

systray status icon

The main feature of the unison runner is it systray status icon. The icon allows knowing in a glance what is the current status of the synchronization.

all good - this means all the syncs have runned without issues the last time.

error - when this icon shows up, one or more of the synchronizations failed.

syncing - when the systray shows this icon, the unison runner is currently running one or more unison instances.

By clicking in the icon the main window is showed (or bought to top), and by clicking on the icon with the second mouse button a small menu is shown:

quit/show menu

windows

The main window can be shown by clicking on the systray icon and it shows a list of all the configured synchronizations, including their current status and the last line of the last synchronization run.

main window

By clicking on the button on the right of the last log line you can see the whole output of the last unison run - inclucing a bit of information about the command that was executed.

sync log window

This window shows the output of the last synchronization run.

configuration

This is the config file you can find in the test directory. Just a few options are supported for each synchronization


#netroot = root of the remote directories
netroot       = .
#max_children = the max number of unison synchs running at the same time
max_children  = 2
#frequency = how often is each folder sync'd in seconds.
frequency     = 60

[test]
local   = local
remote  = remote

# [sync-name]
# local = [needed] path of the local directory
# remote = [needed] path of the remote directory
# paths = paths,to,sync - list of paths to synchronize - sync only these paths
# excludes=paths,to,exclude - list of paths to exclude - these are not sync'd

potential WTFs

  • skiped if the remote is empty - I use this to synchronize between my desktop and my SMB NAS. I mount the NAS using ftab mounts. In my setup if the remote directory is empty, it means that the share was not mounted, so I don't want to run unison on that empty directory. If you are starting to sync files to a new, empty share, you can manual run the unison command once - you can get it from the log window of your sync.

  • smbnetfs doesn't work - well, maybe it does for you, but I didn't manage to make it work on my setup, and didn't want to spend too much time time making it work, specially because I don't have problems mounting my shares with ftab entries. If you manage to make unison work with smbnetfs tell me how, please.

Unknows

  • remote shell and/or socket methods - I want to test this with ssh and socket methods, but I didn't yet - I don't have a current need or a server running unison to test it quickly. If you test it, let me know.

Bug, suggestions, merge requests

Bug reports and suggestions are always welcome in the Magick Source.

Merge requests are even more welcome.

License

This is licensed as free software, under the Artistic License.