"DIY Dropbox" or "2-way directory (r)sync with proper deletion"
Switch branches/tags
Nothing to show
Pull request Compare This branch is 55 commits behind sickill:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.



Build Status


bitpocket is a small but smart script that does 2-way directory synchronization. It uses rsync to do efficient data transfer and tracks local file creation/removal to avoid known rsync problem when doing 2-way syncing with deletion.

bitpocket can use any server which you have ssh access to for its central storage. If you have gigabytes of free disk space on your hosting server you can finally make use of it.

If you find this tool interesting please vote on my EuRuKo 2012 talk proposal about how I used RSpec to test bitpocket: https://github.com/euruko2012/call-for-proposals/pull/11.


Clone repository and symlink bitpocket bin to sth in your $PATH:

$ git clone git://github.com/sickill/bitpocket.git
$ ln -s `pwd`/bitpocket/bin/bitpocket ~/bin/bitpocket

Or download script and place it in a directory in your $PATH:

$ curl -sL https://raw.github.com/sickill/bitpocket/master/bin/bitpocket > ~/bin/bitpocket
$ chmod +x ~/bin/bitpocket

Setting up master

Create empty directory on some host that will be the master copy of your files:

$ ssh user@example.org
$ mkdir ~/BitPocketMaster

Setting up slaves

On each machine you want to synchronize initialize empty directory as your bitpocket:

$ mkdir ~/BitPocket
$ cd ~/BitPocket
$ bitpocket init user@example.org ~/BitPocketMaster

Manual sync

Now whenever you want to sync with master just run bitpocket sync inside your bitpocket directory:

$ cd ~/BitPocket
$ bitpocket sync

Automatic sync with cron

Add following line to your crontab to synchronize every 5 minutes:

*/5 * * * * cd ~/BitPocket && nice ~/bin/bitpocket cron

Note that cron usually has very limited environment and your ssh keys with passphrases won't work in cron jobs as ssh-agents/keyrings don't work there. Thus it's preferable to generate passphrase-less ssh key for bitpocket authentication:

$ cd ~/BitPocket
$ ssh-keygen -t rsa -C bitpocket-`hostname` -N '' -f .bitpocket/id_rsa
$ ssh-copy-id -i .bitpocket/id_rsa user@example.org

and uncomment line with RSYNC_SSH in .bitpocket/config file.


Custom rsync options

You can pass additional switches to rsync by setting RSYNC_OPTS in .bitpocket/config file. Generated config file includes (commented out) example setting for dereferencing symlinks:


Just uncomment it and change at will.

Exclude files

If you want some files to be ignored by bitpocket you can create .bitpocket/exclude file and list the paths there:


*.avi and jola will be matched anywhere in path, misio.txt will be matched at bitpocket root dir (~/BitPocket/misio.txt).

This exclude file is passed to rsync as --exclude-from argument, check man rsync for INCLUDE/EXCLUDE PATTERN RULES.

Slow sync callbacks

When syncing takes more than 10 seconds (SLOW_SYNC_TIME setting) bitpocket can fire off user provided command in background. This can be usefull to notify user about long sync happening, preventing him from turning off the machine during sync etc.

There are 3 settings that can be enabled in .bitpocket/config file:

# SLOW_SYNC_START_CMD="notify-send 'BitPocket sync in progress...'"
# SLOW_SYNC_STOP_CMD="notify-send 'BitPocket sync finished'"

Just uncomment them and change at will.

You can show tray icon during long sync with traytor and following settings:

SLOW_SYNC_START_CMD='~/bin/traytor -t "BitPocket syncing..." -c "xdg-open ." .bitpocket/icons & echo $! >.bitpocket/traytor.pid'
SLOW_SYNC_STOP_CMD='kill `cat .bitpocket/traytor.pid`'

Displaying logs

When running bitpocket in cron with bitpocket cron it will append its output to .bitpocket/log file. You can watch live log with following command:

$ cd ~/BitPocket
$ bitpocket log

File versioning

bitpocket doesn't support any kind of file versioning at the moment. It's just a glue script that uses rsync for the real job.

However there is a discussion about possible solutions here: github.com/sickill/bitpocket/issues/15


Marcin Kulik | @sickill | https://github.com/sickill | http://ku1ik.com/