The Tahoe-LAFS decentralized secure filesystem.
Go to file
Brian Warner 20787853dd docs: stop suggesting 'activate', too much to explain
Also it avoids the failure mode where a user forgets to activate the
virtualenv, types the recommended "pip install" command, and installs
stuff directly to their system instead of safely confined inside the
virtualenv.
2016-03-26 14:13:23 -07:00
docs docs: stop suggesting 'activate', too much to explain 2016-03-26 14:13:23 -07:00
misc add misc/coding_tools/graph-deps.py, to visualize dependencies 2016-03-25 14:50:16 -07:00
src/allmydata test/check_memory: stop using .tac files 2016-03-25 16:26:29 -07:00
static Eliminate mock dependency. 2015-07-17 22:12:25 +01:00
.appveyor.yml turn on appveyor CI 2016-03-15 13:02:56 -07:00
.gitignore minor .egg-info name-change cleanups 2016-03-25 12:55:09 -07:00
.travis.yml travis: enable cache, should speed up builds a lot 2016-03-15 18:41:59 -07:00
COPYING.GPL Fix repeated 'the' in license text. 2011-08-19 13:48:36 -07:00
COPYING.TGPPL.rst magic first line tells emacs to use utf8+bom 2013-11-08 21:08:05 +00:00
CREDITS CREDITS: add my GPG key 2015-04-26 15:07:55 -07:00
Dockerfile Dockerfile: git-pull more history, to get a version string 2015-06-15 14:40:19 -07:00
Makefile update Makefile too 2016-03-25 12:58:05 -07:00
MANIFEST.in MANIFEST.in: remove obsolete contents 2016-03-22 13:39:51 -07:00
NEWS.rst NEWS: instructions for the distribution-name change 2016-03-25 12:39:38 -07:00
README.rst docs: stop suggesting 'activate', too much to explain 2016-03-26 14:13:23 -07:00
relnotes.txt Change some instances of "filesystem" that were missed to "file store". 2015-07-31 18:21:47 +01:00
setup.cfg setup.cfg: remove --find-links 2016-03-26 12:23:01 -07:00
setup.py setup: remove zip_safe, no one uses eggs anymore 2016-03-26 12:21:57 -07:00
Tahoe.home rename bin/allmydata-tahoe to bin/tahoe. Closes #155. 2007-10-11 03:38:24 -07:00
tox.ini tox: run tahoe --version for buildbot, remove update_version 2016-03-17 22:01:33 -07:00

==========
Tahoe-LAFS
==========

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.

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
* `Mac`_ and Windows installers are in development.

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
`<docs/windows.rst>`_.

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 venv``
* ``venv/bin/pip install --editable .``
* ``venv/bin/tahoe --version``

To run the unit test suite:

* ``tox``

For more detailed instructions, read `<docs/INSTALL.rst>`_ .

Once ``tahoe --version`` works, see `<docs/running.rst>`_ to learn how to set
up your first Tahoe-LAFS node.

LICENCE
=======

Copyright 2006-2016 The Tahoe-LAFS Software Foundation

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 Public License, version 2. See the file `COPYING.TGPPL`_ for
the terms of the Transitive Grace Period Public Licence, version 1.0.

See `TGPPL.PDF`_ for why the TGPPL exists, graphically illustrated on three
slides.

.. _OSPackages: https://tahoe-lafs.org/trac/tahoe-lafs/wiki/OSPackages
.. _Mac: docs/OS-X.rst
.. _pip: https://pip.pypa.io/en/stable/installing/
.. _COPYING.GPL: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.GPL
.. _COPYING.TGPPL: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.TGPPL.rst
.. _TGPPL.PDF: https://tahoe-lafs.org/~zooko/tgppl.pdf

----

.. 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