tahoe-lafs/README.rst
Jean-Paul Calderone 7ea994776d
Merge pull request from Fenn-CS/3781.remove-incomplete-cli-warning-python3
Python 3 support complete, so removed warning

Fixes: ticket:3781
2021-09-10 12:15:33 -04:00

6.8 KiB
Raw Blame History

Free and Open Decentralized Data Store

image0

Tahoe-LAFS (Tahoe Least-Authority File Store) is the first free software / open-source storage technology that distributes your data across multiple servers. Even if some servers fail or are taken over by an attacker, the entire file store continues to function correctly, preserving your privacy and security.

code of conduct documentation status circleci githubactions code coverage

Table of contents

💡 About Tahoe-LAFS

Tahoe-LAFS helps you to store files while granting confidentiality, integrity, and availability of your data.

How does it work? You run a client program on your computer, which talks to one or more storage servers on other computers. When you tell your client to store a file, it will encrypt that file, encode it into multiple pieces, then spread those pieces out among various servers. The pieces are all encrypted and protected against modifications. Later, when you ask your client to retrieve the file, it will find the necessary pieces, make sure they havent been corrupted, reassemble them, and decrypt the result.

image2
The image is taken from meejah's blog post at Torproject.org.

The client creates pieces (“shares”) that have a configurable amount of redundancy, so even if some servers fail, you can still get your data back. Corrupt shares are detected and ignored so that the system can tolerate server-side hard-drive errors. All files are encrypted (with a unique key) before uploading, so even a malicious server operator cannot read your data. The only thing you ask of the servers is that they can (usually) provide the shares when you ask for them: you arent relying upon them for confidentiality, integrity, or absolute availability.

Tahoe-LAFS was first designed in 2007, following the "principle of least authority", a security best practice requiring system components to only have the privilege necessary to complete their intended function and not more.

Please read more about Tahoe-LAFS architecture here.

Installation

For more detailed instructions, read Installing Tahoe-LAFS.

Once tahoe --version works, see How to Run Tahoe-LAFS to learn how to set up your first Tahoe-LAFS node.

🐍 Python 3 Support

Python 3 support has been introduced starting with Tahoe-LAFS 1.16.0, alongside Python 2. System administrators are advised to start running Tahoe on Python 3 and should expect Python 2 support to be dropped in a future version. Please, feel free to file issues if you run into bugs while running Tahoe on Python 3.

🤖 Issues

Tahoe-LAFS uses the Trac instance to track issues. Please email jean-paul plus tahoe-lafs at leastauthority dot com for an account.

📑 Documentation

You can find the full Tahoe-LAFS documentation at our documentation site.

💬 Community

Get involved with the Tahoe-LAFS community:

🤗 Contributing

As a community-driven open source project, Tahoe-LAFS welcomes contributions of any form:

Before authoring or reviewing a patch, please familiarize yourself with the Coding Standard and the Contributor Code of Conduct.

🤝 Supporters

We would like to thank Fosshost for supporting us with hosting services. If your open source project needs help, you can apply for their support.

FAQ

Need more information? Please check our FAQ page.

📄 License

Copyright 2006-2020 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 choice, any later version. (You may choose to use this package under the terms of either license, 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.