tahoe-lafs/tahoe-lafs
tahoe-lafs
/
tahoe-lafs
2
0
Fork 0
Code Issues Pull Requests 23 Packages Projects Releases 1 Wiki Activity
The Tahoe-LAFS decentralized secure filesystem.
6,250 Commits 200 Branches 89 Tags 172 MiB
Python 96.3%
CSS 1.8%
HTML 0.9%
Nix 0.4%
Shell 0.3%
Other 0.2%
Go to file
Brian Warner be463cd36c OS-X: move Contents down into misc/ 2016-03-16 12:23:13 -07:00
docs edit to explain to newbies what "the top-level directory" is 2016-03-13 14:35:48 +00:00
misc OS-X: move Contents down into misc/ 2016-03-16 12:23:13 -07:00
src fix test_runner.BinTahoe.test_the_right_code 2016-03-15 18:15: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 move 'check-memory' from Makefile into tox.ini 2016-03-08 21:19:41 -08: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
MANIFEST.in MANIFEST.in: add some missing files so tarballs are complete 2015-05-21 15:59:19 -07:00
Makefile copy bin/tahoe from $PATH for the sake of test_runner 2016-03-15 17:31:32 +00:00
NEWS.rst README/NEWS: new pip/virtualenv -based docs 2016-03-15 12:33:50 -07:00
README.rst README/NEWS: new pip/virtualenv -based docs 2016-03-15 12:33:50 -07:00
Tahoe.home rename bin/allmydata-tahoe to bin/tahoe. Closes #155. 2007-10-11 03:38:24 -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 Make 'pip install -e .' or 'setup.py develop' update the version. 2016-03-15 17:31:32 +00:00
setup.py setup.py: remove 'make_executable' command 2016-03-15 18:19:54 -07:00
tox.ini setup.py: remove 'make_executable' command 2016-03-15 18:19:54 -07:00

README.rst 

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

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.rst`_ 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
.. _pip: https://pip.pypa.io/en/stable/installing/
.. _WindowsInstall: docs/windows.rst
.. _docs/running.rst: docs/running.rst
.. _quickstart.rst: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/docs/quickstart.rst
.. _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
.. _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