2011-11-18 00:15:11 +00:00
|
|
|
==========
|
2010-05-04 09:43:40 +00:00
|
|
|
Tahoe-LAFS
|
2011-11-18 00:15:11 +00:00
|
|
|
==========
|
2010-05-04 09:43:40 +00:00
|
|
|
|
2015-04-10 22:42:57 +00:00
|
|
|
Tahoe-LAFS is a Free and Open decentralized cloud storage system. It distributes
|
|
|
|
|
your data across multiple servers. Even if some of the servers fail or are taken
|
|
|
|
|
over by an attacker, the entire file store continues to function correctly,
|
|
|
|
|
preserving your privacy and security.
|
2010-05-04 09:43:40 +00:00
|
|
|
|
2016-03-08 05:29:42 +00:00
|
|
|
INSTALLING
|
|
|
|
|
==========
|
|
|
|
|
|
|
|
|
|
Pre-packaged versions are available for several operating systems:
|
|
|
|
|
|
|
|
|
|
* Debian and Ubuntu users can `apt-get install tahoe-lafs`
|
|
|
|
|
* NixOS, NetBSD (pkgsrc), ArchLinux, Slackware, and Gentoo have packages
|
|
|
|
|
available, see `OSPackages`_ for details
|
2016-03-16 19:50:48 +00:00
|
|
|
* `Mac`_ and Windows installers are in development.
|
2016-03-08 05:29:42 +00:00
|
|
|
|
|
|
|
|
If you don't use an OS package, you'll need Python 2.7 and `pip`_. You may
|
|
|
|
|
also need a C compiler, and the development headers for python, libffi, and
|
|
|
|
|
OpenSSL. On a Debian-like system, use `apt-get install build-essential
|
|
|
|
|
python-dev libffi-dev libssl-dev python-virtualenv`. On Windows, see
|
|
|
|
|
`WindowsInstall`_.
|
|
|
|
|
|
|
|
|
|
Then, to install the most recent release, just run:
|
|
|
|
|
|
|
|
|
|
* `pip install tahoe-lafs`
|
|
|
|
|
|
|
|
|
|
To install from source (either so you can hack on it, or just to run
|
|
|
|
|
pre-release code), you should create a virtualenv and install into that:
|
|
|
|
|
|
|
|
|
|
* `git clone https://github.com/tahoe-lafs/tahoe-lafs.git`
|
|
|
|
|
* `cd tahoe-lafs`
|
|
|
|
|
* `virtualenv tahoe`
|
|
|
|
|
* `source tahoe/bin/activate`
|
|
|
|
|
* `pip install --editable .`
|
|
|
|
|
* `tahoe --version`
|
|
|
|
|
|
|
|
|
|
To run the unit test suite:
|
|
|
|
|
|
|
|
|
|
* `tox`
|
|
|
|
|
|
|
|
|
|
For more details, see the docs directory.
|
|
|
|
|
|
|
|
|
|
Once `tahoe --version` works, see `docs/running.rst`_ to learn how to set up
|
|
|
|
|
your first Tahoe-LAFS node.
|
2010-05-04 09:43:40 +00:00
|
|
|
|
|
|
|
|
LICENCE
|
|
|
|
|
=======
|
|
|
|
|
|
2016-03-08 05:29:42 +00:00
|
|
|
Copyright 2006-2016 The Tahoe-LAFS Software Foundation
|
2012-03-13 20:50:57 +00:00
|
|
|
|
2010-05-18 17:42:40 +00:00
|
|
|
You may use this package under the GNU General Public License, version 2 or, at
|
|
|
|
|
your option, any later version. You may use this package under the Transitive
|
|
|
|
|
Grace Period Public Licence, version 1.0, or at your option, any later
|
|
|
|
|
version. (You may choose to use this package under the terms of either licence,
|
|
|
|
|
at your option.) See the file `COPYING.GPL`_ for the terms of the GNU General
|
2011-08-19 06:01:42 +00:00
|
|
|
Public License, version 2. See the file `COPYING.TGPPL.rst`_ for the terms of
|
2010-05-18 17:42:40 +00:00
|
|
|
the Transitive Grace Period Public Licence, version 1.0.
|
2010-05-04 09:43:40 +00:00
|
|
|
|
|
|
|
|
See `TGPPL.PDF`_ for why the TGPPL exists, graphically illustrated on three slides.
|
|
|
|
|
|
2016-03-08 05:29:42 +00:00
|
|
|
.. _OSPackages: https://tahoe-lafs.org/trac/tahoe-lafs/wiki/OSPackages
|
2016-03-16 19:50:48 +00:00
|
|
|
.. _Mac: docs/OS-X.rst
|
2016-03-08 05:29:42 +00:00
|
|
|
.. _pip: https://pip.pypa.io/en/stable/installing/
|
|
|
|
|
.. _WindowsInstall: docs/windows.rst
|
|
|
|
|
.. _docs/running.rst: docs/running.rst
|
2016-03-26 01:26:54 +00:00
|
|
|
.. _INSTALL.rst: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/docs/INSTALL.rst
|
2013-04-02 17:46:52 +00:00
|
|
|
.. _COPYING.GPL: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.GPL
|
|
|
|
|
.. _COPYING.TGPPL.rst: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.TGPPL.rst
|
2011-10-29 19:42:40 +00:00
|
|
|
.. _TGPPL.PDF: https://tahoe-lafs.org/~zooko/tgppl.pdf
|
2014-09-09 17:51:44 +00:00
|
|
|
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
.. image:: https://travis-ci.org/tahoe-lafs/tahoe-lafs.png?branch=master
|
|
|
|
|
:target: https://travis-ci.org/tahoe-lafs/tahoe-lafs
|
|
|
|
|
|
|
|
|
|
.. image:: https://coveralls.io/repos/tahoe-lafs/tahoe-lafs/badge.png?branch=master
|
|
|
|
|
:target: https://coveralls.io/r/tahoe-lafs/tahoe-lafs?branch=master
|
