minor docs tweaks
* use correct fixed-width-font markup * fix hyperlinks to neighboring (github-side) .rst files * refer to python-2.7.11 consistently (thanks to PRab for the catch)
This commit is contained in:
Brian Warner
parent
a63263dc55
commit
365977bf51
60
README.rst
60
README.rst
|
|
@ -2,73 +2,71 @@
|
||||||
Tahoe-LAFS
|
Tahoe-LAFS
|
||||||
==========
|
==========
|
||||||
|
|
||||||
Tahoe-LAFS is a Free and Open decentralized cloud storage system. It distributes
|
Tahoe-LAFS is a Free and Open decentralized cloud storage system. It
|
||||||
your data across multiple servers. Even if some of the servers fail or are taken
|
distributes your data across multiple servers. Even if some of the servers
|
||||||
over by an attacker, the entire file store continues to function correctly,
|
fail or are taken over by an attacker, the entire file store continues to
|
||||||
preserving your privacy and security.
|
function correctly, preserving your privacy and security.
|
||||||
|
|
||||||
INSTALLING
|
INSTALLING
|
||||||
==========
|
==========
|
||||||
|
|
||||||
Pre-packaged versions are available for several operating systems:
|
Pre-packaged versions are available for several operating systems:
|
||||||
|
|
||||||
* Debian and Ubuntu users can `apt-get install tahoe-lafs`
|
* Debian and Ubuntu users can ``apt-get install tahoe-lafs``
|
||||||
* NixOS, NetBSD (pkgsrc), ArchLinux, Slackware, and Gentoo have packages
|
* NixOS, NetBSD (pkgsrc), ArchLinux, Slackware, and Gentoo have packages
|
||||||
available, see `OSPackages`_ for details
|
available, see `OSPackages`_ for details
|
||||||
* `Mac`_ and Windows installers are in development.
|
* `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
|
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
|
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
|
OpenSSL. On a Debian-like system, use ``apt-get install build-essential
|
||||||
python-dev libffi-dev libssl-dev python-virtualenv`. On Windows, see
|
python-dev libffi-dev libssl-dev python-virtualenv``. On Windows, see
|
||||||
`WindowsInstall`_.
|
`<docs/windows.rst>`_.
|
||||||
|
|
||||||
Then, to install the most recent release, just run:
|
Then, to install the most recent release, just run:
|
||||||
|
|
||||||
* `pip install tahoe-lafs`
|
* ``pip install tahoe-lafs``
|
||||||
|
|
||||||
To install from source (either so you can hack on it, or just to run
|
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:
|
pre-release code), you should create a virtualenv and install into that:
|
||||||
|
|
||||||
* `git clone https://github.com/tahoe-lafs/tahoe-lafs.git`
|
* ``git clone https://github.com/tahoe-lafs/tahoe-lafs.git``
|
||||||
* `cd tahoe-lafs`
|
* ``cd tahoe-lafs``
|
||||||
* `virtualenv tahoe`
|
* ``virtualenv tahoe``
|
||||||
* `. tahoe/bin/activate`
|
* ``. tahoe/bin/activate``
|
||||||
* `pip install --editable .`
|
* ``pip install --editable .``
|
||||||
* `tahoe --version`
|
* ``tahoe --version``
|
||||||
|
|
||||||
To run the unit test suite:
|
To run the unit test suite:
|
||||||
|
|
||||||
* `tox`
|
* ``tox``
|
||||||
|
|
||||||
For more details, see the docs directory.
|
For more detailed instructions, read `<docs/INSTALL.rst>`_ .
|
||||||
|
|
||||||
Once `tahoe --version` works, see `docs/running.rst`_ to learn how to set up
|
Once ``tahoe --version`` works, see `<docs/running.rst>`_ to learn how to set
|
||||||
your first Tahoe-LAFS node.
|
up your first Tahoe-LAFS node.
|
||||||
|
|
||||||
LICENCE
|
LICENCE
|
||||||
=======
|
=======
|
||||||
|
|
||||||
Copyright 2006-2016 The Tahoe-LAFS Software Foundation
|
Copyright 2006-2016 The Tahoe-LAFS Software Foundation
|
||||||
|
|
||||||
You may use this package under the GNU General Public License, version 2 or, at
|
You may use this package under the GNU General Public License, version 2 or,
|
||||||
your option, any later version. You may use this package under the Transitive
|
at your option, any later version. You may use this package under the
|
||||||
Grace Period Public Licence, version 1.0, or at your option, any later
|
Transitive Grace Period Public Licence, version 1.0, or at your option, any
|
||||||
version. (You may choose to use this package under the terms of either licence,
|
later version. (You may choose to use this package under the terms of either
|
||||||
at your option.) See the file `COPYING.GPL`_ for the terms of the GNU General
|
licence, at your option.) See the file `COPYING.GPL`_ for the terms of the
|
||||||
Public License, version 2. See the file `COPYING.TGPPL.rst`_ for the terms of
|
GNU General Public License, version 2. See the file `COPYING.TGPPL`_ for
|
||||||
the Transitive Grace Period Public Licence, version 1.0.
|
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.
|
See `TGPPL.PDF`_ for why the TGPPL exists, graphically illustrated on three
|
||||||
|
slides.
|
||||||
|
|
||||||
.. _OSPackages: https://tahoe-lafs.org/trac/tahoe-lafs/wiki/OSPackages
|
.. _OSPackages: https://tahoe-lafs.org/trac/tahoe-lafs/wiki/OSPackages
|
||||||
.. _Mac: docs/OS-X.rst
|
.. _Mac: docs/OS-X.rst
|
||||||
.. _pip: https://pip.pypa.io/en/stable/installing/
|
.. _pip: https://pip.pypa.io/en/stable/installing/
|
||||||
.. _WindowsInstall: docs/windows.rst
|
|
||||||
.. _docs/running.rst: docs/running.rst
|
|
||||||
.. _INSTALL.rst: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/docs/INSTALL.rst
|
|
||||||
.. _COPYING.GPL: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.GPL
|
.. _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
|
.. _COPYING.TGPPL: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/COPYING.TGPPL.rst
|
||||||
.. _TGPPL.PDF: https://tahoe-lafs.org/~zooko/tgppl.pdf
|
.. _TGPPL.PDF: https://tahoe-lafs.org/~zooko/tgppl.pdf
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,8 @@ Getting Tahoe-LAFS
|
||||||
==================
|
==================
|
||||||
|
|
||||||
Welcome to `the Tahoe-LAFS project`_, a secure, decentralized, fault-tolerant
|
Welcome to `the Tahoe-LAFS project`_, a secure, decentralized, fault-tolerant
|
||||||
storage system. See `about.rst`_ for an overview of the architecture and security properties of the system.
|
storage system. See `<about.rst>`_ for an overview of the architecture and
|
||||||
|
security properties of the system.
|
||||||
|
|
||||||
.. _the Tahoe-LAFS project: https://tahoe-lafs.org
|
.. _the Tahoe-LAFS project: https://tahoe-lafs.org
|
||||||
|
|
||||||
|
|
@ -32,18 +33,19 @@ Pre-Packaged Versions
|
||||||
|
|
||||||
You may not need to build Tahoe at all.
|
You may not need to build Tahoe at all.
|
||||||
|
|
||||||
If you are on Windows, please see `./windows.rst`_ for platform-specific
|
If you are on Windows, please see `<windows.rst>`_ for platform-specific
|
||||||
instructions.
|
instructions.
|
||||||
|
|
||||||
If you are on a Mac, you can either follow these instructions, or use the
|
If you are on a Mac, you can either follow these instructions, or use the
|
||||||
pre-packaged bundle described in `OS-X.rst`_. The Tahoe project hosts
|
pre-packaged bundle described in `<OS-X.rst>`_. The Tahoe project hosts
|
||||||
pre-compiled "wheels" for all dependencies, so use the ``--find-links=``
|
pre-compiled "wheels" for all dependencies, so use the ``--find-links=``
|
||||||
option described below to avoid needing a compiler.
|
option described below to avoid needing a compiler.
|
||||||
|
|
||||||
Many Linux distributions include Tahoe-LAFS packages. Debian and Ubuntu users
|
Many Linux distributions include Tahoe-LAFS packages. Debian and Ubuntu users
|
||||||
can ``apt-get install tahoe-lafs``. See `OSPackages.rst`_ for other
|
can ``apt-get install tahoe-lafs``. See `OSPackages`_ for other
|
||||||
platforms.
|
platforms.
|
||||||
|
|
||||||
|
.. _OSPackages: https://tahoe-lafs.org/trac/tahoe-lafs/wiki/OSPackages
|
||||||
|
|
||||||
|
|
||||||
Preliminaries
|
Preliminaries
|
||||||
|
|
@ -67,7 +69,7 @@ Xcode and its command-line tools.
|
||||||
* python 2.7
|
* python 2.7
|
||||||
|
|
||||||
Check if you already have an adequate version of Python installed by running
|
Check if you already have an adequate version of Python installed by running
|
||||||
``python -V``. The latest version of Python v2.7 is required, which is 2.7.10
|
``python -V``. The latest version of Python v2.7 is required, which is 2.7.11
|
||||||
as of this writing. Python v2.6.x and v3 do not work. On Windows, we
|
as of this writing. Python v2.6.x and v3 do not work. On Windows, we
|
||||||
recommend the use of native Python v2.7, not Cygwin Python. If you don't have
|
recommend the use of native Python v2.7, not Cygwin Python. If you don't have
|
||||||
one of these versions of Python installed, `download`_ and install the latest
|
one of these versions of Python installed, `download`_ and install the latest
|
||||||
|
|
@ -270,4 +272,4 @@ Run Tahoe-LAFS
|
||||||
|
|
||||||
Now you are ready to deploy a decentralized filesystem. The ``tahoe``
|
Now you are ready to deploy a decentralized filesystem. The ``tahoe``
|
||||||
executable can configure and launch your Tahoe-LAFS nodes. See
|
executable can configure and launch your Tahoe-LAFS nodes. See
|
||||||
`<running.rst>`__ for instructions on how to do that.
|
`<running.rst>`_ for instructions on how to do that.
|
||||||
|
|
|
||||||
|
|
@ -1,18 +1,19 @@
|
||||||
Building Tahoe-LAFS on Windows
|
Building Tahoe-LAFS on Windows
|
||||||
==============================
|
==============================
|
||||||
|
|
||||||
You'll need `python`, `pip`, and `virtualenv`. But you won't need a compiler.
|
You'll need ``python``, ``pip``, and ``virtualenv``. But you won't need a
|
||||||
|
compiler.
|
||||||
|
|
||||||
Preliminaries
|
Preliminaries
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
1: Install Python-2.7.10 . Use the "Windows x86-64 MSI installer" at
|
1: Install Python-2.7.11 . Use the "Windows x86-64 MSI installer" at
|
||||||
https://www.python.org/downloads/release/python-2711/
|
https://www.python.org/downloads/release/python-2711/
|
||||||
|
|
||||||
2: That should install `pip`, but if it doesn't, look at
|
2: That should install ``pip``, but if it doesn't, look at
|
||||||
https://pip.pypa.io/en/stable/installing/ for installation instructions.
|
https://pip.pypa.io/en/stable/installing/ for installation instructions.
|
||||||
|
|
||||||
3: Install `virtualenv` with
|
3: Install ``virtualenv`` with
|
||||||
https://virtualenv.pypa.io/en/latest/installation.html
|
https://virtualenv.pypa.io/en/latest/installation.html
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
|
|
@ -29,15 +30,15 @@ You can use whatever name you like for the virtualenv, but example uses
|
||||||
Installing setuptools, pip, wheel...done.
|
Installing setuptools, pip, wheel...done.
|
||||||
>
|
>
|
||||||
|
|
||||||
3: Activate the new virtualenv. This puts the virtualenv's `Scripts`
|
3: Activate the new virtualenv. This puts the virtualenv's ``Scripts``
|
||||||
directory on your PATH, allowing you to run commands that are installed
|
directory on your PATH, allowing you to run commands that are installed
|
||||||
there. The command prompt will change to include `(tahoe)` as a reminder that
|
there. The command prompt will change to include ``(tahoe)`` as a reminder
|
||||||
you've activated the "tahoe" virtualenv::
|
that you've activated the "tahoe" virtualenv::
|
||||||
|
|
||||||
PS C:\Users\me> .\tahoe\Scripts\activate
|
PS C:\Users\me> .\tahoe\Scripts\activate
|
||||||
(tahoe) PS C:\Users\me>
|
(tahoe) PS C:\Users\me>
|
||||||
|
|
||||||
4: Use `pip` to install the latest release of Tahoe-LAFS into this
|
4: Use ``pip`` to install the latest release of Tahoe-LAFS into this
|
||||||
virtualenv::
|
virtualenv::
|
||||||
|
|
||||||
(tahoe) PS C:\Users\me> pip install --find-links=https://tahoe-lafs.org/deps/ tahoe-lafs
|
(tahoe) PS C:\Users\me> pip install --find-links=https://tahoe-lafs.org/deps/ tahoe-lafs
|
||||||
|
|
@ -47,7 +48,7 @@ virtualenv::
|
||||||
Successfully installed ...
|
Successfully installed ...
|
||||||
(tahoe) PS C:\Users\me>
|
(tahoe) PS C:\Users\me>
|
||||||
|
|
||||||
5: Verify that Tahoe was installed correctly by running `tahoe --version`::
|
5: Verify that Tahoe was installed correctly by running ``tahoe --version``::
|
||||||
|
|
||||||
(tahoe) PS C:\Users\me> tahoe --version
|
(tahoe) PS C:\Users\me> tahoe --version
|
||||||
tahoe-lafs: 1.11
|
tahoe-lafs: 1.11
|
||||||
|
|
@ -56,18 +57,18 @@ virtualenv::
|
||||||
Running Tahoe-LAFS
|
Running Tahoe-LAFS
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
The rest of the documentation assumes you can run the `tahoe` executable just
|
The rest of the documentation assumes you can run the ``tahoe`` executable
|
||||||
as you did in step 5 above. If you start a new shell (say, the next time your
|
just as you did in step 5 above. If you start a new shell (say, the next time
|
||||||
boot your computer), you'll need to re-activate the virtualenv as you did in
|
your boot your computer), you'll need to re-activate the virtualenv as you
|
||||||
step 3.
|
did in step 3.
|
||||||
|
|
||||||
Now use the docs in `running.rst`_ to learn how to configure your first Tahoe
|
Now use the docs in `<running.rst>`_ to learn how to configure your first
|
||||||
node.
|
Tahoe node.
|
||||||
|
|
||||||
Installing A Different Version
|
Installing A Different Version
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
The `pip install tahoe-lafs` command above will install the latest release
|
The ``pip install tahoe-lafs`` command above will install the latest release
|
||||||
(from PyPI). If instead, you want to install from a git checkout, then run
|
(from PyPI). If instead, you want to install from a git checkout, then run
|
||||||
the following command (in an activated virtualenv, from the root of your git
|
the following command (in an activated virtualenv, from the root of your git
|
||||||
checkout)::
|
checkout)::
|
||||||
|
|
@ -75,7 +76,7 @@ checkout)::
|
||||||
$ (tahoe) pip install --find-links=https://tahoe-lafs.org/deps/ .
|
$ (tahoe) pip install --find-links=https://tahoe-lafs.org/deps/ .
|
||||||
|
|
||||||
If you're planning to hack on the source code, you might want to add
|
If you're planning to hack on the source code, you might want to add
|
||||||
`--editable` so you won't have to re-install each time you make a change.
|
``--editable`` so you won't have to re-install each time you make a change.
|
||||||
|
|
||||||
Dependencies
|
Dependencies
|
||||||
------------
|
------------
|
||||||
|
|
@ -85,7 +86,7 @@ zfec, pycryptopp, and others. This code must be built separately for each
|
||||||
platform (Windows, OS-X, and different flavors of Linux).
|
platform (Windows, OS-X, and different flavors of Linux).
|
||||||
|
|
||||||
Pre-compiled "wheels" of all Tahoe's dependencies are hosted on the
|
Pre-compiled "wheels" of all Tahoe's dependencies are hosted on the
|
||||||
tahoe-lafs.org website in the `deps/` directory. The `--find-links=` argument
|
tahoe-lafs.org website in the ``deps/`` directory. The ``--find-links=``
|
||||||
(used in the examples above) instructs `pip` to look at that URL for
|
argument (used in the examples above) instructs ``pip`` to look at that URL
|
||||||
dependencies. This should avoid the need for anything to be compiled during
|
for dependencies. This should avoid the need for anything to be compiled
|
||||||
the install.
|
during the install.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue