source: trunk/README.rst

Last change on this file was f08e2ba, checked in by Jean-Paul Calderone <exarkun@…>, at 2020-07-07T13:19:30Z

add some alt text

  • Property mode set to 100644
File size: 3.9 KB
Line 
1==========
2Tahoe-LAFS
3==========
4
5Tahoe-LAFS is a Free and Open decentralized cloud storage system. It
6distributes your data across multiple servers. Even if some of the servers
7fail or are taken over by an attacker, the entire file store continues to
8function correctly, preserving your privacy and security.
9
10For full documentation, please see
11http://tahoe-lafs.readthedocs.io/en/latest/ .
12
13|Contributor Covenant|  |readthedocs|  |travis|  |circleci|  |codecov|
14
15
16INSTALLING
17==========
18
19There are three ways to install Tahoe-LAFS.
20
21using OS packages
22^^^^^^^^^^^^^^^^^
23
24Pre-packaged versions are available for several operating systems:
25
26* Debian and Ubuntu users can ``apt-get install tahoe-lafs``
27* NixOS, NetBSD (pkgsrc), ArchLinux, Slackware, and Gentoo have packages
28  available, see `OSPackages`_ for details
29* `Mac`_ and Windows installers are in development.
30
31via pip
32^^^^^^^
33
34If you don't use an OS package, you'll need Python 2.7 and `pip`_. You may
35also need a C compiler, and the development headers for python, libffi, and
36OpenSSL. On a Debian-like system, use ``apt-get install build-essential
37python-dev libffi-dev libssl-dev python-virtualenv``. On Windows, see
38`<docs/windows.rst>`_.
39
40Then, to install the most recent release, just run:
41
42* ``pip install tahoe-lafs``
43
44from source
45^^^^^^^^^^^
46To install from source (either so you can hack on it, or just to run
47pre-release code), you should create a virtualenv and install into that:
48
49* ``git clone https://github.com/tahoe-lafs/tahoe-lafs.git``
50* ``cd tahoe-lafs``
51* ``virtualenv --python=python2.7 venv``
52* ``venv/bin/pip install --upgrade setuptools``
53* ``venv/bin/pip install --editable .``
54* ``venv/bin/tahoe --version``
55
56To run the unit test suite:
57
58* ``tox``
59
60You can pass arguments to ``trial`` with an environment variable.  For
61example, you can run the test suite on multiple cores to speed it up:
62
63* ``TAHOE_LAFS_TRIAL_ARGS="-j4" tox``
64
65For more detailed instructions, read `<docs/INSTALL.rst>`_ .
66
67Once ``tahoe --version`` works, see `<docs/running.rst>`_ to learn how to set
68up your first Tahoe-LAFS node.
69
70LICENCE
71=======
72
73Copyright 2006-2018 The Tahoe-LAFS Software Foundation
74
75You may use this package under the GNU General Public License, version 2 or,
76at your option, any later version. You may use this package under the
77Transitive Grace Period Public Licence, version 1.0, or at your option, any
78later version. (You may choose to use this package under the terms of either
79licence, at your option.) See the file `COPYING.GPL`_ for the terms of the
80GNU General Public License, version 2. See the file `COPYING.TGPPL`_ for
81the terms of the Transitive Grace Period Public Licence, version 1.0.
82
83See `TGPPL.PDF`_ for why the TGPPL exists, graphically illustrated on three
84slides.
85
86.. _OSPackages: https://tahoe-lafs.org/trac/tahoe-lafs/wiki/OSPackages
87.. _Mac: docs/OS-X.rst
88.. _pip: https://pip.pypa.io/en/stable/installing/
89.. _COPYING.GPL: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.GPL
90.. _COPYING.TGPPL: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.TGPPL.rst
91.. _TGPPL.PDF: https://tahoe-lafs.org/~zooko/tgppl.pdf
92
93----
94
95.. |readthedocs| image:: http://readthedocs.org/projects/tahoe-lafs/badge/?version=latest
96    :alt: documentation status
97    :target: http://tahoe-lafs.readthedocs.io/en/latest/?badge=latest
98
99.. |travis| image:: https://travis-ci.org/tahoe-lafs/tahoe-lafs.png?branch=master
100    :alt: build status
101    :target: https://travis-ci.org/tahoe-lafs/tahoe-lafs
102
103.. |circleci| image:: https://circleci.com/gh/tahoe-lafs/tahoe-lafs.svg?style=svg
104    :target: https://circleci.com/gh/tahoe-lafs/tahoe-lafs
105
106.. |codecov| image:: https://codecov.io/github/tahoe-lafs/tahoe-lafs/coverage.svg?branch=master
107    :alt: test coverage percentage
108    :target: https://codecov.io/github/tahoe-lafs/tahoe-lafs?branch=master
109
110.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
111    :alt: code of conduct
112    :target: docs/CODE_OF_CONDUCT.md
Note: See TracBrowser for help on using the repository browser.