| 1 | .. -*- coding: utf-8-with-signature-unix; fill-column: 77 -*- |
|---|
| 2 | |
|---|
| 3 | .. |
|---|
| 4 | note: if you aren't reading the rendered form of these docs at |
|---|
| 5 | http://tahoe-lafs.readthedocs.io/en/latest/ , then be aware that any |
|---|
| 6 | ":doc:" links refer to other files in this docs/ directory |
|---|
| 7 | |
|---|
| 8 | ********************* |
|---|
| 9 | Installing Tahoe-LAFS |
|---|
| 10 | ********************* |
|---|
| 11 | |
|---|
| 12 | `Tahoe-LAFS`_ is a secure, decentralized, and fault-tolerant storage system. |
|---|
| 13 | To see an overview of the architecture and security properties, see :doc:`Welcome to Tahoe LAFS! <../about-tahoe>` |
|---|
| 14 | |
|---|
| 15 | Tahoe-LAFS can be installed and used on any of the following operating systems. |
|---|
| 16 | |
|---|
| 17 | .. _Tahoe-LAFS: https://tahoe-lafs.org |
|---|
| 18 | |
|---|
| 19 | Microsoft Windows |
|---|
| 20 | ================= |
|---|
| 21 | |
|---|
| 22 | To install Tahoe-LAFS on Windows: |
|---|
| 23 | |
|---|
| 24 | 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>`_. |
|---|
| 25 | |
|---|
| 26 | 2. Install the latest version of Python 3. Download the .exe file at the `python website <https://www.python.org/downloads/>`_. |
|---|
| 27 | |
|---|
| 28 | 3. Open the installer by double-clicking it. Select the **Add Python to PATH** check-box, then click **Install Now**. |
|---|
| 29 | |
|---|
| 30 | 4. Start PowerShell and enter the following command to verify python installation:: |
|---|
| 31 | |
|---|
| 32 | python --version |
|---|
| 33 | |
|---|
| 34 | 5. Enter the following command to install Tahoe-LAFS:: |
|---|
| 35 | |
|---|
| 36 | pip install tahoe-lafs |
|---|
| 37 | |
|---|
| 38 | 6. Verify installation by checking for the version:: |
|---|
| 39 | |
|---|
| 40 | tahoe --version |
|---|
| 41 | |
|---|
| 42 | 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:`../build/build-on-windows`. |
|---|
| 43 | |
|---|
| 44 | Linux, BSD, or MacOS |
|---|
| 45 | ==================== |
|---|
| 46 | |
|---|
| 47 | 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:: |
|---|
| 48 | |
|---|
| 49 | apt-get install tahoe-lafs |
|---|
| 50 | |
|---|
| 51 | If you are working on MacOS or a Linux distribution which does not have Tahoe-LAFS packages, you can build it yourself: |
|---|
| 52 | |
|---|
| 53 | 1. Make sure the following are installed: |
|---|
| 54 | |
|---|
| 55 | * **Python 3's latest version**: Check for the version by running ``python --version``. |
|---|
| 56 | * **pip**: Most python installations already include `pip`. However, if your installation does not, see `pip installation <https://pip.pypa.io/en/stable/installing/>`_. |
|---|
| 57 | |
|---|
| 58 | 2. Install Tahoe-LAFS using pip:: |
|---|
| 59 | |
|---|
| 60 | pip install tahoe-lafs |
|---|
| 61 | |
|---|
| 62 | 3. Verify installation by checking for the version:: |
|---|
| 63 | |
|---|
| 64 | tahoe --version |
|---|
| 65 | |
|---|
| 66 | 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:`../build/build-on-linux`. |
|---|
| 67 | |
|---|
| 68 | You can always write to the `tahoe-dev mailing list <https://lists.tahoe-lafs.org/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. |
|---|
