mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-18 20:47:54 +00:00

The Tahoe-LAFS decentralized secure filesystem.

Go to file

Brian Warner b7099f147d NEWS: more updates		2016-12-12 17:54:22 -08:00
docs	docs: clean up .rst and references	2016-12-12 13:57:28 -08:00
integration	Adding to the py.test integration tests, this:	2016-10-18 18:06:41 -07:00
misc	make tox env for code-checks	2016-08-19 17:42:05 -07:00
src/allmydata	improve ConnectionStatus and welcome-page display	2016-12-09 18:41:38 -08:00
static	Eliminate mock dependency.	2015-07-17 22:12:25 +01:00
.appveyor.yml	appveyor: no longer need to use tox from upstream git	2016-10-14 09:07:30 -07:00
.coveragerc	tox: add "coverage" environment	2016-05-09 14:32:21 -07:00
.gitignore	remove _appname.py file	2016-08-11 23:24:11 -07:00
.travis.yml	Adding to the py.test integration tests, this:	2016-10-18 18:06:41 -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: update	2016-03-30 16:09:12 -07:00
Dockerfile	Remove $HOME/.cache/ directory after building.	2016-09-26 15:19:04 -07:00
Makefile	make tox env for code-checks	2016-08-19 17:42:05 -07:00
MANIFEST.in	tox.ini missing from MANIFEST	2016-04-12 19:46:49 -06:00
NEWS.rst	NEWS: more updates	2016-12-12 17:54:22 -08:00
README.rst	travis: switch to codecov	2016-10-08 18:53:44 -04:00
relnotes.txt	relnotes, docs: post-release fixups	2016-03-30 17:27:44 -07:00
setup.cfg	setup.cfg: remove --find-links	2016-03-26 12:23:01 -07:00
setup.py	require foolscap >= 0.12.5, for ReconnectionInfo	2016-12-08 15:41:37 -08:00
Tahoe.home	rename bin/allmydata-tahoe to bin/tahoe. Closes #155 .	2007-10-11 03:38:24 -07:00
tox.ini	tox docs: pin docutils-0.12	2016-12-12 12:57:08 -08: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.

For full documentation, please see http://tahoe-lafs.readthedocs.io/en/latest/ .

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

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.