box-linux-sync

Linux client for Box.com

Project description

box-linux-sync - A naïve [Box.com](http://box.com/) Linux Client

An unofficial attempt to create a Linux synchronization client because Box.com does not provide one.

DISCLAIMER

This software is alpha quality and you should keep away from it if you are sane enough. Unless you want to test and improve it, then you’re more than welcome to try it.

Overview

File synchronization is currently done using the WebDAV interface provided by Box.com. There is also a [Python API](https://github.com/box/box-python-sdk) available but I haven’t started to mess with it.

Requirements

[Python](http://www.python.org/download/releases/) 2.7 and up (may work on earlier versions, haven’t tested).
[Davfs2](http://savannah.nongnu.org/projects/davfs2). To install it use:
- Debian, Ubuntu: apt-get install davfs2
- Red Hat, SuSE, Fedora: yum install davfs2
- Gentoo: emerge davfs2
- ArchLinux: pacman -S davfs2

Installation

$ cd ~/path/of/your/choice $ git clone git://github.com/noiselabs/box-linux-sync.git

Installation via Pip is not currently available. Let’s wait for a proper release, OK?.

Usage

###### Check environment and setup box-sync and it’s dependencies:

$ cd ~/path/to/box-linux-sync/bin $ ./box-sync check && ./box-sync setup

###### Edit ~/.noiselabs/box/box-sync.cfg to fit your preferences:

$ vim ~/.noiselabs/box/box-sync.cfg

; box-sync.cfg [main]

; Path to your Box sync dir. Use a relative path to place this dir ; inside $HOME or an absolute path. Default: Box box_dir = Box

; Wether to use a WebDAV filesystem to synchronize your local and ; remote files. Default: true use_davfs = true

###### Start synchronization via Davfs:

$ ./box-sync start

###### Stop synchronization:

$ ./box-sync stop

###### Send box-sync into oblivion when you get tired of it.

This just removes box-sync configuration files and the repository, not your personal Box.com files (unless you have configured the box_sync dir to be inside ~/.noiselabs).