Skip to content

Latest commit

 

History

History
113 lines (72 loc) · 5.38 KB

README.md

File metadata and controls

113 lines (72 loc) · 5.38 KB
Raw

##Hello, this is FileRock Client

This is the client of FileRock, a backup and synchronization service that provides confidentiality and checks the integrity of your data.

For instructions about how to run FileRock Client from the source code, look here.
For the list of required dependencies, look here.
Release notes for FileRock Client are available here.

In order to use FileRock Client, you will need a FileRock account. You can get one here.
If you don't have an invitation code, you can leave your email address on FileRock landing page,
and you will receive one as soon as possible. First arrived, first served ;-)

 ______ _ _      _____            _       _____ _ _            _
|  ____(_) |    |  __ \          | |     / ____| (_)          | |
| |__   _| | ___| |__) |___   ___| | __ | |    | |_  ___ _ __ | |_
|  __| | | |/ _ \  _  // _ \ / __| |/ / | |    | | |/ _ \ '_ \| __|
| |    | | |  __/ | \ \ (_) | (__|   <  | |____| | |  __/ | | | |_
|_|    |_|_|\___|_|  \_\___/ \___|_|\_\  \_____|_|_|\___|_| |_|\__|

Copyright (C) 2012 Heyware s.r.l.

This file is part of FileRock Client.

FileRock Client is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

FileRock Client is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with FileRock Client. If not, see <http://www.gnu.org/licenses/>.

--

###How to run FileRock Client

In order to run FileRock client from the source code, follow these instructions:

  • Make sure that your system has all the required dependencies installed.
  • Clone this repository: git clone https://github.com/filerock/FileRock-Client.git
  • Run the client from its main python script:
    • on Mac OS X, make sure tu use the 32-bit version of python 2.7.x: e.g., python2.7-32 FileRock.py
    • on Linux or Windows, if your default python version is python 2.7.x, just run python FileRock.py
  • Please not that FileRock Client used from the source code does not update itself automatically or notify the user when updates are available. If you run FileRock Client from the source code, you will need to periodically pull from this repository to get the latest version.

Packaged version of FileRock Client are availble here.

We will do our best to keep the code in this repository and the packaged versions synchronized.

--

###Required dependencies

  • Reference python version is 2.7.2

Most of the following dependencies can be easily installed via pip.
If you don't have pip yet, installation instructions are available here.

  • pbkdf2 1.3 - Can be installed through pip or from the tarball
  • pycrypto 2.5 - Can be ckecked out from git or from the tarball
  • wxPython 2.8.12.1 - Can be downloaded from wxpython.org. Binaries for MS Windows are available [here](http://downloads.sourceforge.net/wxpython/wxPython2.8-win32-uni code-2.8.12.1-py27.exe) and for Mac Os X here
  • PIL (Python Image Library) - Can be installed through pip.
    • Installation through pip requires a C compiler
    • Binaries for MS Windows are available here
  • apscheduler 2.0.3 - Can be installed through pip.
  • PySocks 1.04 - Can be ckecked out from git.
  • portalocker 0.3 - Can be installed through pip.

The following are required only on Linux and Mac OS X:

  • setproctitle 1.1.6 - Can be installed through pip.

The following are required only on Mac OS X:

  • xattr 0.6.4 - Can be installed through pip.

The following are required only on MS Windows:

The following are optional dependencies, needed only for the i18n support (that is, translation to languages different from English).

  • distutils-extra 2.37 - Can be checked out from Launchpad.
  • intltool 0.50.2 - Can be checked out from Launchpad.
    • Requires to install a perl interpreter as a dependency.

The following are required only for developers, in order to run the automated tests:

  • nose 1.1.2 - Can be installed through pip.
  • mock 1.0.1 - Can be installed through pip.