mirror of
https://github.com/tahoe-lafs/tahoe-lafs.git
synced 2025-01-17 18:29:54 +00:00
Installation Guide Revamp
This commit is contained in:
Yash Nayani
YashNRam13
parent
8e28a9d0e0
commit
d56c09bd95
343
docs/INSTALL.rst
343
docs/INSTALL.rst
@ -1,343 +0,0 @@
|
||||
.. -*- coding: utf-8-with-signature-unix; fill-column: 77 -*-
|
||||
|
||||
..
|
||||
note: if you aren't reading the rendered form of these docs at
|
||||
http://tahoe-lafs.readthedocs.io/en/latest/ , then be aware that any
|
||||
":doc:" links refer to other files in this docs/ directory
|
||||
|
||||
*********************
|
||||
Installing Tahoe-LAFS
|
||||
*********************
|
||||
|
||||
Welcome to `the Tahoe-LAFS project`_, a secure, decentralized, fault-tolerant
|
||||
storage system. See :doc:`about` for an overview of the architecture and
|
||||
security properties of the system.
|
||||
|
||||
This procedure should work on Windows, Mac, illumos (previously OpenSolaris),
|
||||
and too many flavors of Linux and of BSD to list.
|
||||
|
||||
.. _the Tahoe-LAFS project: https://tahoe-lafs.org
|
||||
|
||||
First: In Case Of Trouble
|
||||
=========================
|
||||
|
||||
In some cases these instructions may fail due to peculiarities of your
|
||||
platform.
|
||||
|
||||
If the following instructions don't Just Work without any further effort on
|
||||
your part, then please write to `the tahoe-dev mailing list`_ where friendly
|
||||
hackers will help you out.
|
||||
|
||||
.. _the tahoe-dev mailing list: https://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev
|
||||
|
||||
Pre-Packaged Versions
|
||||
=====================
|
||||
|
||||
You may not need to build Tahoe at all.
|
||||
|
||||
If you are on Windows, please see :doc:`windows` for platform-specific
|
||||
instructions.
|
||||
|
||||
If you are on a Mac, you can either follow these instructions, or use the
|
||||
pre-packaged bundle described in :doc:`OS-X`.
|
||||
|
||||
Many Linux distributions include Tahoe-LAFS packages. Debian and Ubuntu users
|
||||
can ``apt-get install tahoe-lafs``. See `OSPackages`_ for other
|
||||
platforms.
|
||||
|
||||
.. _OSPackages: https://tahoe-lafs.org/trac/tahoe-lafs/wiki/OSPackages
|
||||
|
||||
|
||||
Preliminaries
|
||||
=============
|
||||
|
||||
If you don't use a pre-packaged copy of Tahoe, you can build it yourself.
|
||||
You'll need Python2.7, pip, and virtualenv.
|
||||
Tahoe-LAFS depends on some libraries which require a C compiler to build.
|
||||
However, for many platforms, PyPI hosts already-built packages of libraries.
|
||||
|
||||
If there is no already-built package for your platform,
|
||||
you will need a C compiler,
|
||||
the Python development headers,
|
||||
and some libraries (libffi-dev and libssl-dev).
|
||||
|
||||
On a modern Debian/Ubuntu-derived distribution, this command will get you
|
||||
everything you need::
|
||||
|
||||
apt-get install build-essential python-dev libffi-dev libssl-dev libyaml-dev python-virtualenv
|
||||
|
||||
On OS-X, install pip and virtualenv as described below. If you want to
|
||||
compile the dependencies yourself, you'll also need to install
|
||||
Xcode and its command-line tools.
|
||||
|
||||
**Note** that Tahoe-LAFS depends on `openssl 1.1.1c` or greater.
|
||||
|
||||
Python 2.7
|
||||
----------
|
||||
|
||||
Check if you already have an adequate version of Python installed by running
|
||||
``python -V``. The latest version of Python v2.7 is recommended, which is
|
||||
2.7.11 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
|
||||
one of these versions of Python installed, `download`_ and install the latest
|
||||
version of Python v2.7. Make sure that the path to the installation directory
|
||||
has no spaces in it (e.g. on Windows, do not install Python in the "Program
|
||||
Files" directory)::
|
||||
|
||||
% python --version
|
||||
Python 2.7.11
|
||||
|
||||
.. _download: https://www.python.org/downloads/
|
||||
|
||||
pip
|
||||
---
|
||||
|
||||
Many Python installations already include ``pip``, but in case yours does
|
||||
not, get it with the `pip install instructions`_::
|
||||
|
||||
% pip --version
|
||||
pip 10.0.1 from ... (python 2.7)
|
||||
|
||||
.. _pip install instructions: https://pip.pypa.io/en/stable/installing/
|
||||
|
||||
virtualenv
|
||||
----------
|
||||
|
||||
If you do not have an OS-provided copy of ``virtualenv``, install it with the
|
||||
instructions from the `virtualenv documentation`_::
|
||||
|
||||
|
||||
% virtualenv --version
|
||||
15.1.0
|
||||
|
||||
.. _virtualenv documentation: https://virtualenv.pypa.io/en/latest/installation.html
|
||||
|
||||
C compiler and libraries
|
||||
------------------------
|
||||
|
||||
Except on OS-X, where the Tahoe project hosts pre-compiled wheels for all
|
||||
dependencies, you will need several C libraries installed before you can
|
||||
build. You will also need the Python development headers, and a C compiler
|
||||
(your python installation should know how to find these).
|
||||
|
||||
On Debian/Ubuntu-derived systems, the necessary packages are ``python-dev``,
|
||||
``libffi-dev``, and ``libssl-dev``, and can be installed with ``apt-get``. On
|
||||
RPM-based system (like Fedora) these may be named ``python-devel``, etc,
|
||||
instead, and cam be installed with ``yum`` or ``rpm``.
|
||||
|
||||
**Note** that Tahoe-LAFS depends on `openssl 1.1.1c` or greater.
|
||||
|
||||
|
||||
Install the Latest Tahoe-LAFS Release
|
||||
=====================================
|
||||
|
||||
We recommend creating a fresh virtualenv for your Tahoe-LAFS install, to
|
||||
isolate it from any python packages that are already installed (and to
|
||||
isolate the rest of your system from Tahoe's dependencies).
|
||||
|
||||
This example uses a virtualenv named ``venv``, but you can call it anything
|
||||
you like. Many people prefer to keep all their virtualenvs in one place, like
|
||||
``~/.local/venvs/`` or ``~/venvs/``.
|
||||
|
||||
It's usually a good idea to upgrade the virtualenv's ``pip`` and
|
||||
``setuptools`` to their latest versions, with ``venv/bin/pip install -U pip
|
||||
setuptools``. Many operating systems have an older version of ``virtualenv``,
|
||||
which then includes older versions of pip and setuptools. Upgrading is easy,
|
||||
and only affects the virtualenv: not the rest of your computer.
|
||||
|
||||
Then use the virtualenv's ``pip`` to install the latest Tahoe-LAFS release
|
||||
from PyPI with ``venv/bin/pip install tahoe-lafs``. After installation, run
|
||||
``venv/bin/tahoe --version`` to confirm the install was successful::
|
||||
|
||||
% virtualenv venv
|
||||
New python executable in ~/venv/bin/python2.7
|
||||
Installing setuptools, pip, wheel...done.
|
||||
|
||||
% venv/bin/pip install -U pip setuptools
|
||||
Downloading/unpacking pip from https://pypi.python.org/...
|
||||
...
|
||||
Successfully installed pip setuptools
|
||||
|
||||
% venv/bin/pip install tahoe-lafs
|
||||
Collecting tahoe-lafs
|
||||
...
|
||||
Installing collected packages: ...
|
||||
Successfully installed ...
|
||||
|
||||
% venv/bin/tahoe --version
|
||||
tahoe-lafs: 1.15.1
|
||||
foolscap: ...
|
||||
|
||||
%
|
||||
|
||||
Install From a Source Tarball
|
||||
-----------------------------
|
||||
|
||||
You can also install directly from the source tarball URL. To verify
|
||||
signatures, first see verifying_signatures_ and replace the URL in the
|
||||
following instructions with the local filename.
|
||||
|
||||
% virtualenv venv
|
||||
New python executable in ~/venv/bin/python2.7
|
||||
Installing setuptools, pip, wheel...done.
|
||||
|
||||
% venv/bin/pip install https://tahoe-lafs.org/downloads/tahoe-lafs-1.15.1.tar.gz
|
||||
Collecting https://tahoe-lafs.org/downloads/tahoe-lafs-1.15.1.tar.gz
|
||||
...
|
||||
Installing collected packages: ...
|
||||
Successfully installed ...
|
||||
|
||||
% venv/bin/tahoe --version
|
||||
tahoe-lafs: 1.15.1
|
||||
...
|
||||
|
||||
.. _verifying_signatures:
|
||||
|
||||
Verifying Signatures
|
||||
--------------------
|
||||
|
||||
First download the source tarball and then any signatures. There are several
|
||||
developers who are able to produce signatures for a release. A release may
|
||||
have multiple signatures. All should be valid and you should confirm at least
|
||||
one of them (ideally, confirm all).
|
||||
|
||||
This statement, signed by the existing Tahoe release-signing key, attests to
|
||||
those developers authorized to sign a Tahoe release:
|
||||
|
||||
.. include:: developer-release-signatures
|
||||
:code:
|
||||
|
||||
Signatures are made available beside the release. So for example, a release
|
||||
like ``https://tahoe-lafs.org/downloads/tahoe-lafs-1.16.0.tar.gz`` might
|
||||
have signatures ``tahoe-lafs-1.16.0.tar.gz.meejah.asc`` and
|
||||
``tahoe-lafs-1.16.0.tar.gz.warner.asc``.
|
||||
|
||||
To verify the signatures using GnuPG::
|
||||
|
||||
% gpg --verify tahoe-lafs-1.16.0.tar.gz.meejah.asc tahoe-lafs-1.16.0.tar.gz
|
||||
gpg: Signature made XXX
|
||||
gpg: using RSA key 9D5A2BD5688ECB889DEBCD3FC2602803128069A7
|
||||
gpg: Good signature from "meejah <meejah@meejah.ca>" [full]
|
||||
% gpg --verify tahoe-lafs-1.16.0.tar.gz.warner.asc tahoe-lafs-1.16.0.tar.gz
|
||||
gpg: Signature made XXX
|
||||
gpg: using RSA key 967EFE06699872411A77DF36D43B4C9C73225AAF
|
||||
gpg: Good signature from "Brian Warner <warner@lothar.com>" [full]
|
||||
|
||||
|
||||
|
||||
Extras
|
||||
------
|
||||
|
||||
Tahoe-LAFS provides some functionality only when explicitly requested at installation time.
|
||||
It does this using the "extras" feature of setuptools.
|
||||
You can request these extra features when running the ``pip install`` command like this::
|
||||
|
||||
% venv/bin/pip install tahoe-lafs[tor]
|
||||
|
||||
This example enables support for listening and connecting using Tor.
|
||||
The Tahoe-LAFS documentation for specific features which require an explicit install-time step will mention the "extra" that must be requested.
|
||||
|
||||
Hacking On Tahoe-LAFS
|
||||
---------------------
|
||||
|
||||
To modify the Tahoe source code, you should get a git checkout, and install
|
||||
with the ``--editable`` flag. You should also use the ``[test]`` extra to get
|
||||
the additional libraries needed to run the unit tests::
|
||||
|
||||
% git clone https://github.com/tahoe-lafs/tahoe-lafs.git
|
||||
|
||||
% cd tahoe-lafs
|
||||
|
||||
% virtualenv venv
|
||||
|
||||
% venv/bin/pip install --editable .[test]
|
||||
Obtaining file::~/tahoe-lafs
|
||||
...
|
||||
Successfully installed ...
|
||||
|
||||
% venv/bin/tahoe --version
|
||||
tahoe-lafs: 1.15.1
|
||||
...
|
||||
|
||||
This way, you won't have to re-run the ``pip install`` step each time you
|
||||
modify the source code.
|
||||
|
||||
Running the ``tahoe`` executable
|
||||
================================
|
||||
|
||||
The rest of the Tahoe-LAFS documentation assumes that you can run the
|
||||
``tahoe`` executable that you just created. You have four basic options:
|
||||
|
||||
* Use the full path each time (e.g. ``~/venv/bin/tahoe``).
|
||||
* "`Activate`_" the virtualenv with ``. venv/bin/activate``, to get a
|
||||
subshell with a ``$PATH`` that includes the ``venv/bin/`` directory, then
|
||||
you can just run ``tahoe``.
|
||||
* Change your ``$PATH`` to include the ``venv/bin/`` directory, so you can
|
||||
just run ``tahoe``.
|
||||
* Symlink from ``~/bin/tahoe`` to the ``tahoe`` executable. Since ``~/bin``
|
||||
is typically in your ``$PATH`` (at least if it exists when you log in),
|
||||
this will let you just run ``tahoe``.
|
||||
|
||||
You might also find the `pipsi`_ tool convenient: ``pipsi install
|
||||
tahoe-lafs`` will create a new virtualenv, install tahoe into it, then
|
||||
symlink just the executable (into ``~/.local/bin/tahoe``). Then either add
|
||||
``~/.local/bin/`` to your ``$PATH``, or make one last symlink into
|
||||
``~/bin/tahoe``.
|
||||
|
||||
.. _Activate: https://virtualenv.pypa.io/en/latest/userguide.html#activate-script
|
||||
.. _pipsi: https://pypi.python.org/pypi/pipsi/0.9
|
||||
|
||||
Running the Self-Tests
|
||||
======================
|
||||
|
||||
To run the self-tests from a source tree, you'll need ``tox`` installed. On a
|
||||
Debian/Ubuntu system, use ``apt-get install tox``. You can also install it
|
||||
into your tahoe-specific virtualenv with ``pip install tox``.
|
||||
|
||||
Then just run ``tox``. This will create a new fresh virtualenv, install Tahoe
|
||||
(from the source tree, including any changes you have made) and all its
|
||||
dependencies (including testing-only dependencies) into the virtualenv, then
|
||||
run the unit tests. This ensures that the tests are repeatable and match the
|
||||
results of other users, unaffected by any other Python packages installed on
|
||||
your machine. On a modern computer this will take 5-10 minutes, and should
|
||||
result in a "all tests passed" mesage::
|
||||
|
||||
% tox
|
||||
GLOB sdist-make: ~/tahoe-lafs/setup.py
|
||||
py27 recreate: ~/tahoe-lafs/.tox/py27
|
||||
py27 inst: ~/tahoe-lafs/.tox/dist/tahoe-lafs-1.15.1.zip
|
||||
py27 runtests: commands[0] | tahoe --version
|
||||
py27 runtests: commands[1] | trial --rterrors allmydata
|
||||
allmydata.test.test_auth
|
||||
AccountFileCheckerKeyTests
|
||||
test_authenticated ... [OK]
|
||||
test_missing_signature ... [OK]
|
||||
...
|
||||
Ran 1186 tests in 423.179s
|
||||
|
||||
PASSED (skips=7, expectedFailures=3, successes=1176)
|
||||
__________________________ summary ___________________________________
|
||||
py27: commands succeeded
|
||||
congratulations :)
|
||||
|
||||
Common Problems
|
||||
===============
|
||||
|
||||
If you see an error like ``fatal error: Python.h: No such file or directory``
|
||||
while compiling the dependencies, you need the Python development headers. If
|
||||
you are on a Debian or Ubuntu system, you can install them with ``sudo
|
||||
apt-get install python-dev``. On RedHat/Fedora, install ``python-devel``.
|
||||
|
||||
Similar errors about ``openssl/crypto.h`` indicate that you are missing the
|
||||
OpenSSL development headers (``libssl-dev``). Likewise ``ffi.h`` means you
|
||||
need ``libffi-dev``.
|
||||
|
||||
**Note** that Tahoe-LAFS depends on `openssl 1.1.1c` or greater.
|
||||
|
||||
|
||||
Using Tahoe-LAFS
|
||||
================
|
||||
|
||||
Now you are ready to deploy a decentralized filesystem. You will use the
|
||||
``tahoe`` executable to create, configure, and launch your Tahoe-LAFS nodes.
|
||||
See :doc:`running` for instructions on how to do that.
|
||||
@ -1,6 +1,6 @@
|
||||
******************************************
|
||||
How To Build Tahoe-LAFS On A Desert Island
|
||||
******************************************
|
||||
***************************************
|
||||
Building Tahoe-LAFS On A Desert Island
|
||||
***************************************
|
||||
|
||||
(or an airplane, or anywhere else without internet connectivity)
|
||||
|
||||
75
docs/Installation/install-on-linux.rst
Normal file
75
docs/Installation/install-on-linux.rst
Normal file
@ -0,0 +1,75 @@
|
||||
****************************
|
||||
Building Tahoe-LAFS on Linux
|
||||
****************************
|
||||
|
||||
Tahoe-LAFS has made packages available for installing on many linux and BSD distributions.
|
||||
Debian and Ubuntu users can use ``apt-get install tahoe-lafs``.
|
||||
If you are working on a Linux distribution which does not have Tahoe-LAFS or are looking to hack on the source code, you can build Tahoe-LAFS yourself:
|
||||
|
||||
Prerequisites
|
||||
=============
|
||||
|
||||
Make sure the following are installed:
|
||||
|
||||
* **Python 3's latest version**: Check for the version by running ``python --version``.
|
||||
* **pip**: Most python installations already include ``pip``. However, if your installation does not, see `pip installation <https://pip.pypa.io/en/stable/installing/>`_.
|
||||
* **virtualenv**: Use ``pip`` to install virtualenv::
|
||||
|
||||
pip install --user virtualenv
|
||||
|
||||
* **C compiler and libraries**:
|
||||
|
||||
* ``python-dev``: Python development headers.
|
||||
* ``libffi-dev``: Foreign Functions Interface library.
|
||||
* ``libssl-dev``: SSL library, Tahoe-LAFS needs OpenSSL version 1.1.1c or greater.
|
||||
|
||||
.. note::
|
||||
If you are working on Debian or Ubuntu, you can install the necessary libraries using ``apt-get``::
|
||||
|
||||
apt-get install python-dev libffi-dev libssl-dev
|
||||
|
||||
On an RPM-based system such as Fedora, you can install the necessary libraries using ``yum`` or ``rpm``. However, the packages may be named differently.
|
||||
|
||||
Install the Latest Tahoe-LAFS Release
|
||||
=====================================
|
||||
|
||||
If you are looking to hack on the source code or run pre-release code, we recommend you install Tahoe-LAFS directly from source by creating a ``virtualenv`` instance:
|
||||
|
||||
1. Clone the Tahoe-LAFS repository::
|
||||
|
||||
git clone https://github.com/tahoe-lafs/tahoe-lafs.git
|
||||
|
||||
2. Move into the tahoe-lafs directory::
|
||||
|
||||
cd tahoe-lafs
|
||||
|
||||
3. Create a fresh virtualenv for your Tahoe-LAFS install::
|
||||
|
||||
virtualenv venv
|
||||
|
||||
.. note::
|
||||
venv is the name of the virtual environment in this example. Use any name for your environment.
|
||||
|
||||
4. Upgrade ``pip`` and ``setuptools`` on the newly created virtual environment::
|
||||
|
||||
venv/bin/pip install -U pip setuptools
|
||||
|
||||
5. If you'd like to modify the Tahoe source code, you need to install Tahoe-LAFS with the ``--editable`` flag with the ``test`` extra::
|
||||
|
||||
venv/bin/pip install --editable .[test]
|
||||
|
||||
.. note::
|
||||
Tahoe-LAFS provides extra functionality when requested explicitly at installation using the "extras" feature of setuptools. To learn more about the extras which Tahoe supports, see Tahoe extras.
|
||||
|
||||
6. Verify installation by checking for the version::
|
||||
|
||||
venv/bin/tahoe --version
|
||||
|
||||
If you do not want to use the full path, i.e., ``venv/bin/tahoe`` everytime you want to run tahoe, you can activate the ``virtualenv``::
|
||||
|
||||
. venv/bin/activate
|
||||
|
||||
This will generate a subshell with a ``$PATH`` that includes the ``venv/bin/`` directory.
|
||||
|
||||
|
||||
|
||||
45
docs/Installation/install-on-windows.rst
Normal file
45
docs/Installation/install-on-windows.rst
Normal file
@ -0,0 +1,45 @@
|
||||
******************************
|
||||
Building Tahoe-LAFS on Windows
|
||||
******************************
|
||||
|
||||
If you are looking to hack on the source code or run pre-release code, we recommend you create a virtualenv instance and install Tahoe-LAFS into that:
|
||||
|
||||
|
||||
1. Make sure you have Powershell installed. See `PowerShell installation <https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-windows?view=powershell-7.1>`_.
|
||||
|
||||
2. Install the latest version of Python 3. Download the .exe file at the `python website <https://www.python.org/downloads/>`_.
|
||||
|
||||
3. Open the installer by double-clicking it. Select the **Add Python to PATH** check-box, then click **Install Now**.
|
||||
|
||||
4. Start PowerShell and enter the following command to verify python installation::
|
||||
|
||||
python --version
|
||||
|
||||
5. Use ``pip`` to install ``virtualenv``::
|
||||
|
||||
pip install --user virtualenv
|
||||
|
||||
6. Create a fresh virtualenv for your Tahoe-LAFS install using the following command::
|
||||
|
||||
virtualenv venv
|
||||
|
||||
.. note::
|
||||
venv is the name of the virtual environment in this example. Use any name for your environment.
|
||||
|
||||
7. Use pip to install Tahoe-LAFS in the virtualenv instance::
|
||||
|
||||
venv\Scripts\pip install tahoe-lafs
|
||||
|
||||
6. Verify installation by checking for the version::
|
||||
|
||||
venv\Scripts\tahoe --version
|
||||
|
||||
If you do not want to use the full path, i.e. ``venv\Scripts\tahoe`` everytime you want to run tahoe, you can:
|
||||
|
||||
* Activate the virtualenv::
|
||||
|
||||
. venv\Scripts\activate
|
||||
|
||||
This will generate a subshell with a ``$PATH`` that includes the ``venv\Scripts\`` directory.
|
||||
|
||||
* Change your ``$PATH`` to include the ``venv\Scripts`` directory.
|
||||
68
docs/Installation/install-tahoe.rst
Normal file
68
docs/Installation/install-tahoe.rst
Normal file
@ -0,0 +1,68 @@
|
||||
.. -*- coding: utf-8-with-signature-unix; fill-column: 77 -*-
|
||||
|
||||
..
|
||||
note: if you aren't reading the rendered form of these docs at
|
||||
http://tahoe-lafs.readthedocs.io/en/latest/ , then be aware that any
|
||||
":doc:" links refer to other files in this docs/ directory
|
||||
|
||||
*********************
|
||||
Installing Tahoe-LAFS
|
||||
*********************
|
||||
|
||||
`Tahoe-LAFS`_ is a secure, decentralized, and fault-tolerant storage system.
|
||||
To see an overview of the architecture and security properties, see :doc:`Welcome to Tahoe LAFS! <../about-tahoe>`
|
||||
|
||||
Tahoe-LAFS can be installed and used on any of the following operating systems.
|
||||
|
||||
.. _Tahoe-LAFS: https://tahoe-lafs.org
|
||||
|
||||
Microsoft Windows
|
||||
=================
|
||||
|
||||
To install Tahoe-LAFS on Windows:
|
||||
|
||||
1. Make sure you have Powershell installed. See `PowerShell installation <https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-windows?view=powershell-7.1>`_.
|
||||
|
||||
2. Install the latest version of Python 3. Download the .exe file at the `python website <https://www.python.org/downloads/>`_.
|
||||
|
||||
3. Open the installer by double-clicking it. Select the **Add Python to PATH** check-box, then click **Install Now**.
|
||||
|
||||
4. Start PowerShell and enter the following command to verify python installation::
|
||||
|
||||
python --version
|
||||
|
||||
5. Enter the following command to install Tahoe-LAFS::
|
||||
|
||||
pip install tahoe-lafs
|
||||
|
||||
6. Verify installation by checking for the version::
|
||||
|
||||
tahoe --version
|
||||
|
||||
If you want to hack on Tahoe's source code, you can install Tahoe in a ``virtualenv`` on your Windows Machine. To learn more, see :doc:`install-on-windows`.
|
||||
|
||||
Linux, BSD, or MacOS
|
||||
====================
|
||||
|
||||
Tahoe-LAFS can be installed on MacOS, many Linux and BSD distributions. If you are using Ubuntu or Debian, run the following command to install Tahoe-LAFS::
|
||||
|
||||
apt-get install tahoe-lafs
|
||||
|
||||
If you are working on MacOS or a Linux distribution which does not have Tahoe-LAFS packages, you can build it yourself:
|
||||
|
||||
1. Make sure the following are installed:
|
||||
|
||||
* **Python 3's latest version**: Check for the version by running ``python --version``.
|
||||
* **pip**: Most python installations already include `pip`. However, if your installation does not, see `pip installation <https://pip.pypa.io/en/stable/installing/>`_.
|
||||
|
||||
2. Install Tahoe-LAFS using pip::
|
||||
|
||||
pip install tahoe-lafs
|
||||
|
||||
3. Verify installation by checking for the version::
|
||||
|
||||
tahoe --version
|
||||
|
||||
If you are looking to hack on the source code or run pre-release code, we recommend you install Tahoe-LAFS on a `virtualenv` instance. To learn more, see :doc:`install-on-linux`.
|
||||
|
||||
You can always write to the `tahoe-dev mailing list <https://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev>`_ or chat on the `Libera.chat IRC <irc://irc.libera.chat/%23tahoe-lafs>`_ if you are not able to get Tahoe-LAFS up and running on your deployment.
|
||||
@ -1,23 +0,0 @@
|
||||
==============
|
||||
OS-X Packaging
|
||||
==============
|
||||
|
||||
Pre-built Tahoe-LAFS ".pkg" installers for OS-X are generated with each
|
||||
source-code commit. These installers offer an easy way to get Tahoe and all
|
||||
its dependencies installed on your Mac. They do not yet provide a
|
||||
double-clickable application: after installation, you will have a "tahoe"
|
||||
command-line tool, which you can use from a shell (a Terminal window) just as
|
||||
if you'd installed from source.
|
||||
|
||||
Installers are available from this directory:
|
||||
|
||||
https://tahoe-lafs.org/source/tahoe-lafs/tarballs/OS-X-packages/
|
||||
|
||||
Download the latest .pkg file to your computer and double-click on it. This
|
||||
will install to /Applications/tahoe.app, however the app icon there is not
|
||||
how you use Tahoe (launching it will get you a dialog box with a reminder to
|
||||
use Terminal). ``/Applications/tahoe.app/bin/tahoe`` is the executable. The
|
||||
next shell you start ought to have that directory in your $PATH (thanks to a
|
||||
file in ``/etc/paths.d/``), unless your ``.profile`` overrides it.
|
||||
|
||||
Tahoe-LAFS is also easy to install with pip, as described in the README.
|
||||
@ -127,7 +127,7 @@ For more technical detail, please see the `the doc page`_ on the Wiki.
|
||||
Get Started
|
||||
===========
|
||||
|
||||
To use Tahoe-LAFS, please see :doc:`INSTALL`.
|
||||
To use Tahoe-LAFS, please see :doc:`Installing Tahoe-LAFS <../Installation/install-tahoe>`.
|
||||
|
||||
License
|
||||
=======
|
||||
@ -10,8 +10,11 @@ Contents:
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
about
|
||||
INSTALL
|
||||
about-tahoe
|
||||
Installation/install-tahoe
|
||||
Installation/install-on-windows
|
||||
Installation/install-on-linux
|
||||
Installation/install-on-desert-island
|
||||
running
|
||||
magic-wormhole-invites
|
||||
configuration
|
||||
@ -50,10 +53,7 @@ Contents:
|
||||
logging
|
||||
stats
|
||||
|
||||
desert-island
|
||||
debian
|
||||
windows
|
||||
OS-X
|
||||
build/build-pyOpenSSL
|
||||
|
||||
specifications/index
|
||||
|
||||
@ -70,7 +70,7 @@ Create Branch and Apply Updates
|
||||
- commit it
|
||||
|
||||
- update "docs/known_issues.rst" if appropriate
|
||||
- update "docs/INSTALL.rst" references to the new release
|
||||
- update "docs/Installation/install-tahoe.rst" references to the new release
|
||||
- Push the branch to github
|
||||
- Create a (draft) PR; this should trigger CI (note that github
|
||||
doesn't let you create a PR without some changes on the branch so
|
||||
|
||||
@ -10,7 +10,7 @@ Introduction
|
||||
|
||||
This is how to run a Tahoe-LAFS client or a complete Tahoe-LAFS grid.
|
||||
First you have to install the Tahoe-LAFS software, as documented in
|
||||
:doc:`INSTALL`.
|
||||
:doc:`Installing Tahoe-LAFS <../Installation/install-tahoe>`.
|
||||
|
||||
The ``tahoe`` program in your virtualenv's ``bin`` directory is used to
|
||||
create, start, and stop nodes. Each node lives in a separate base
|
||||
|
||||
@ -1,83 +0,0 @@
|
||||
Building Tahoe-LAFS on Windows
|
||||
==============================
|
||||
|
||||
You'll need ``python``, ``pip``, and ``virtualenv``. But you won't need a
|
||||
compiler.
|
||||
|
||||
Preliminaries
|
||||
-------------
|
||||
|
||||
1: Install Python-2.7.11 . Use the "Windows x86-64 MSI installer" at
|
||||
https://www.python.org/downloads/release/python-2711/
|
||||
|
||||
2: That should install ``pip``, but if it doesn't, look at
|
||||
https://pip.pypa.io/en/stable/installing/ for installation instructions.
|
||||
|
||||
3: Install ``virtualenv`` with
|
||||
https://virtualenv.pypa.io/en/latest/installation.html
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
1: Start a CLI shell (e.g. PowerShell)
|
||||
|
||||
2: Create a new virtualenv. Everything specific to Tahoe will go into this.
|
||||
You can use whatever name you like for the virtualenv, but example uses
|
||||
"venv"::
|
||||
|
||||
PS C:\Users\me> virtualenv venv
|
||||
New python executable in C:\Users\me\venv\Scripts\python.exe
|
||||
Installing setuptools, pip, wheel...done.
|
||||
>
|
||||
|
||||
3: Use the virtualenv's ``pip`` to install the latest release of Tahoe-LAFS
|
||||
into this virtualenv::
|
||||
|
||||
PS C:\Users\me> venv\Scripts\pip install tahoe-lafs
|
||||
Collecting tahoe-lafs
|
||||
...
|
||||
Installing collected packages: ...
|
||||
Successfully installed ...
|
||||
>
|
||||
|
||||
4: Verify that Tahoe was installed correctly by running ``tahoe --version``,
|
||||
using the ``tahoe`` from the virtualenv's Scripts directory::
|
||||
|
||||
PS C:\Users\me> venv\Scripts\tahoe --version
|
||||
tahoe-lafs: 1.11
|
||||
foolscap: ...
|
||||
|
||||
Running Tahoe-LAFS
|
||||
------------------
|
||||
|
||||
The rest of the documentation assumes you can run the ``tahoe`` executable
|
||||
just as you did in step 4 above. If you want to type just ``tahoe`` instead
|
||||
of ``venv\Scripts\tahoe``, you can either "`activate`_" the virtualenv (by
|
||||
running ``venv\Scripts\activate``, or you can add the Scripts directory to
|
||||
your ``%PATH%`` environment variable.
|
||||
|
||||
Now use the docs in :doc:`running` to learn how to configure your first
|
||||
Tahoe node.
|
||||
|
||||
.. _activate: https://virtualenv.pypa.io/en/latest/userguide.html#activate-script
|
||||
|
||||
Installing A Different Version
|
||||
------------------------------
|
||||
|
||||
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
|
||||
the following command (using pip from the virtualenv, from the root of your
|
||||
git checkout)::
|
||||
|
||||
$ venv\Scripts\pip install .
|
||||
|
||||
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.
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
Tahoe-LAFS depends upon several packages that use compiled C code (such as zfec).
|
||||
This code must be built separately for each platform (Windows, OS-X, and different flavors of Linux).
|
||||
Fortunately, this is now done by upstream packages for most platforms.
|
||||
The result is that a C compiler is usually not required to install Tahoe-LAFS.
|
||||
1
newsfragments/3747.documentation
Normal file
1
newsfragments/3747.documentation
Normal file
@ -0,0 +1 @@
|
||||
Rewriting the installation guide for Tahoe-LAFS.
|
||||
Loading…
Reference in New Issue
Block a user