source: trunk/README.rst

Last change on this file was 046d9cf, checked in by Itamar Turner-Trauring <itamar@…>, at 2023-01-09T19:25:47Z

Another meaningless tweak.

  • Property mode set to 100644
File size: 7.0 KB
Line 
1======================================
2Free and Open Decentralized Data Store
3======================================
4
5|image0|
6
7`Tahoe-LAFS <https://www.tahoe-lafs.org>`__ (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.
8
9|Contributor Covenant|  |readthedocs|  |circleci|  |githubactions|  |coveralls|
10
11
12Table of contents
13
14-  `About Tahoe-LAFS <#about-tahoe-lafs>`__
15
16-  `Installation <#installation>`__
17
18-  `Issues <#issues>`__
19
20-  `Documentation <#documentation>`__
21
22-  `Community <#community>`__
23
24-  `Contributing <#contributing>`__
25
26-  `FAQ <#faq>`__
27
28-  `License <#license>`__
29
30💡 About Tahoe-LAFS
31-------------------
32
33Tahoe-LAFS helps you to store files while granting confidentiality, integrity, and availability of your data.
34
35How 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 haven’t been corrupted, reassemble them, and decrypt the result.
36
37| |image2|
38| *The image is taken from meejah's* \  `blog <https://blog.torproject.org/tor-heart-tahoe-lafs>`__ \  *post at Torproject.org.*
39
40|
41
42The 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 aren’t relying upon them for confidentiality, integrity, or absolute availability.
43
44Tahoe-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.
45
46Please read more about Tahoe-LAFS architecture `here <docs/architecture.rst>`__.
47
48✅ Installation
49---------------
50
51For more detailed instructions, read `Installing Tahoe-LAFS <docs/Installation/install-tahoe.rst>`__.
52
53
54Once ``tahoe --version`` works, see `How to Run Tahoe-LAFS <docs/running.rst>`__ to learn how to set up your first Tahoe-LAFS node.
55
56🐍 Python 2
57-----------
58
59Python 3.8 or later is required.
60If you are still using Python 2.7, use Tahoe-LAFS version 1.17.1.
61
62
63🤖 Issues
64---------
65
66Tahoe-LAFS uses the Trac instance to track `issues <https://www.tahoe-lafs.org/trac/tahoe-lafs/wiki/ViewTickets>`__. Please email jean-paul plus tahoe-lafs at leastauthority dot com for an account.
67
68📑 Documentation
69----------------
70
71You can find the full Tahoe-LAFS documentation at our `documentation site <http://tahoe-lafs.readthedocs.io/en/latest/>`__.
72
73💬 Community
74------------
75
76Get involved with the Tahoe-LAFS community:
77
78-  Chat with Tahoe-LAFS developers at ``#tahoe-lafs`` channel on `libera.chat <https://libera.chat/>`__ IRC network or `Slack <https://join.slack.com/t/tahoe-lafs/shared_invite/zt-jqfj12r5-ZZ5z3RvHnubKVADpP~JINQ>`__.
79
80-  Join our `weekly conference calls <https://www.tahoe-lafs.org/trac/tahoe-lafs/wiki/WeeklyMeeting>`__ with core developers and interested community members.
81
82-  Subscribe to `the tahoe-dev mailing list <https://lists.tahoe-lafs.org/mailman/listinfo/tahoe-dev>`__, the community forum for discussion of Tahoe-LAFS design, implementation, and usage.
83
84🤗 Contributing
85---------------
86
87As a community-driven open source project, Tahoe-LAFS welcomes contributions of any form:
88
89-  `Code patches <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Patches>`__
90
91-  `Documentation improvements <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Doc>`__
92
93-  `Bug reports <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug>`__
94
95-  `Patch reviews <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/PatchReviewProcess>`__
96
97Before authoring or reviewing a patch, please familiarize yourself with the `Coding Standard <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/CodingStandards>`__ and the `Contributor Code of Conduct <docs/CODE_OF_CONDUCT.md>`__.
98
99
100🥳 First Contribution?
101----------------------
102
103If you are committing to Tahoe for the very first time, it's required that you add your name to our contributor list in `CREDITS <CREDITS>`__. Please ensure that this addition has it's own commit within your first contribution.
104
105
106🤝 Supporters
107--------------
108
109We would like to thank `Fosshost <https://fosshost.org>`__ for supporting us with hosting services. If your open source project needs help, you can apply for their support.
110
111We are grateful to `Oregon State University Open Source Lab <https://osuosl.org/>`__ for hosting tahoe-dev mailing list.
112
113❓ FAQ
114------
115
116Need more information? Please check our `FAQ page <https://www.tahoe-lafs.org/trac/tahoe-lafs/wiki/FAQ>`__.
117
118📄 License
119----------
120
121Copyright 2006-2020 The Tahoe-LAFS Software Foundation
122
123You 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 <COPYING.GPL>`__ for the terms of the GNU General Public License, version 2. See the file `COPYING.TGPPL <COPYING.TGPPL.rst>`__ for the terms of the Transitive Grace Period Public Licence, version 1.0.
124
125See `TGPPL.PDF <https://tahoe-lafs.org/~zooko/tgppl.pdf>`__ for why the TGPPL exists, graphically illustrated on three slides.
126
127.. |image0| image:: docs/_static/media/image2.png
128   :width: 3in
129   :height: 0.91667in
130.. |image2| image:: docs/_static/media/image1.png
131   :width: 6.9252in
132   :height: 2.73611in
133.. |readthedocs| image:: http://readthedocs.org/projects/tahoe-lafs/badge/?version=latest
134    :alt: documentation status
135    :target: http://tahoe-lafs.readthedocs.io/en/latest/?badge=latest
136
137.. |circleci| image:: https://circleci.com/gh/tahoe-lafs/tahoe-lafs.svg?style=svg
138    :target: https://circleci.com/gh/tahoe-lafs/tahoe-lafs
139
140.. |githubactions| image:: https://github.com/tahoe-lafs/tahoe-lafs/actions/workflows/ci.yml/badge.svg
141    :target: https://github.com/tahoe-lafs/tahoe-lafs/actions
142
143.. |coveralls| image:: https://coveralls.io/repos/github/tahoe-lafs/tahoe-lafs/badge.svg
144    :alt: code coverage
145    :target: https://coveralls.io/github/tahoe-lafs/tahoe-lafs
146
147.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
148    :alt: code of conduct
149    :target: docs/CODE_OF_CONDUCT.md
Note: See TracBrowser for help on using the repository browser.