Changes between Version 22 and Version 23 of InstallDetails


Ignore:
Timestamp:
2010-04-03T19:33:26Z (11 years ago)
Author:
zooko
Comment:

renaming to "Tahoe-LAFS" plus a few corrections and few small edits

Legend:

Unmodified
Added
Removed
Modified
  • InstallDetails

    v22 v23  
    22
    33Hopefully, the basic install docs in
    4 [http://allmydata.org/source/tahoe/trunk/docs/install.html docs/install.html]
     4[http://tahoe-lafs.org/source/tahoe-lafs/trunk/docs/install.html docs/install.html]
    55are enough for the most common use cases. This page provides additional
    66information for specific platforms.
    77
    88Please feel free to add sections to this page with anything you might learn
    9 while building Tahoe on other platforms. Information which may be useful in
     9while building Tahoe-LAFS on other platforms. Information which may be useful in
    1010the most general cases will be folded into docs/install.html .
    1111
     
    1818`zope.interface: 3.5.0, simplejson: 2.0.7, pyutil: 1.3.30, zbase32: 1.1.1, allmydata-tahoe: 1.2.0-r3353, pyOpenSSL: 0.7, Twisted: 8.1.0-r25700, Nevow: 0.9.33-r17166, foolscap: 0.3.2, zfec: 1.4.2, pycryptopp: 0.5.12, argparse: 0.8.0, setuptools: 0.6c10dev`
    1919
    20 In addition to these, if you are installing on Microsoft Windows, then you need to manually install [http://sourceforge.net/projects/pywin32 pywin32] before installing Tahoe.
     20In addition to these, if you are installing on Microsoft Windows, then you need to manually install [http://sourceforge.net/projects/pywin32 pywin32] before installing Tahoe-LAFS.
    2121
    2222== Overview ==
    2323
    24 Tahoe is happy to build and run in-place, from a source tree. It is not
     24Tahoe-LAFS is happy to build and run in-place, from a source tree. It is not
    2525necessary to install it (outside the source tree) before use, but if you'd
    2626like to do so, please read the "Installing Outside The Source Tree" section
    2727below.
    2828
    29 However, it does need to be "built" before running it in place. While Tahoe
     29However, it does need to be "built" before running it in place. While Tahoe-LAFS
    3030itself is pure-python and therefore does not require a distinct compile step,
    3131the mechanics that make it easy to run-in-place do require a setup phase. In
    32 addition, Tahoe uses several third-party python libraries to work its magic,
     32addition, Tahoe-LAFS uses several third-party python libraries to work its magic,
    3333many of which are unlikely to be just "lying around" and already installed.
    3434Several of these use compiled C code, so they '''do''' require a compile
    3535step.
    3636
    37 The "make all" target will download and build any third-party libraries that
     37{{{python setup.py build}}} will download and build any third-party libraries that
    3838are not already available on your system. It will also prepare the source
    39 tree for running-in-place. The details: this target is equivalent to
    40 executing "{{{setup.py build_tahoe}}}", and basically does a
    41 "{{{setup.py develop}}}" into a tree-local
     39tree for running-in-place. Thios basically does a
     40"{{{setup.py develop}}}" into a local
    4241{{{./support/lib/python2.5/site-packages/}}} directory. The {{{bin/tahoe}}}
    43 executable knows that it should add this directory to PYTHONPATH before it
     42executable knows that it adds this directory to PYTHONPATH before it
    4443does anything else.
    4544
    4645After building, you can run the source tree's {{{bin/tahoe}}} script to
    47 create, configure, and use your new Tahoe node. As long as {{{bin/tahoe}}} is
     46create, configure, and use your new Tahoe-LAFS node. As long as {{{bin/tahoe}}} is
    4847left inside the built source tree, it can be run from anywhere (even through a
    4948symlink). So until you delete the source tree, you can
     
    5352== the "Desert Island" Build ==
    5453
    55 Tahoe will download and install most of the libraries it requires when you
    56 run "{{{make}}}". You might want to pre-download these libraries: perhaps you
     54Tahoe-LAFS will download and install most of the libraries it requires when you
     55run "{{{python setup.py build}}}". You might want to pre-download these libraries: perhaps you
    5756are about to get on an airplane, or you anticipate having poor network
    5857connectivity, or you just don't like the idea of a so-called compile step
     
    6463This disconnected-build operation is supported in two ways. When building
    6564from a darcs checkout, you can download the latest "tahoe-deps" bundle from
    66 http://allmydata.org/source/tahoe/deps/tahoe-deps.tar.gz . Unpack this in
     65http://tahoe-lafs.org/source/tahoe-lafs/deps/tahoe-deps.tar.gz . Unpack this in
    6766your source tree, and the build process will grab any necessary libraries
    6867from its {{{tahoe-deps/}}} directory instead of downloading them from the
     
    7170
    7271Alternatively, if you are building from a tarball (either a release tarball
    73 from http://allmydata.org/source/tahoe/releases/ , or a continually-generated
    74 current-trunk tarball from http://allmydata.org/source/tahoe/tarballs/ ), you
     72from http://tahoe-lafs.org/source/tahoe-lafs/releases/ , or a continually-generated
     73current-trunk tarball from http://tahoe-lafs.org/source/tahoe-lafs/tarballs/ ), you
    7574can simply download the -SUMO version of the tarball instead of the regular
    7675one. The "SUMO" tarball includes the current tahoe-deps bundle pre-unpacked
     
    7978The tahoe-deps bundle is updated every once in a while, as new versions of
    8079the dependent libraries are released, or as Tahoe becomes dependent upon new
    81 things. The http://allmydata.org/source/tahoe/deps/ directory contains
     80things. The http://tahoe-lafs.org/source/tahoe-lafs/deps/ directory contains
    8281historical ones, but there should never be a reason to use anything but the
    8382latest. The tahoe-deps bundle contains a README that has a version number.
     
    8685== Installing Outside The Source Tree ==
    8786
    88 If you want to use Tahoe without keeping the source tree around, you will
     87If you want to use Tahoe-LAFS without keeping the source tree around, you will
    8988need to actually install it somewhere. You have several options.
    9089
    9190=== Installing The Latest Release ===
    9291
    93 "{{{easy_install allmydata-tahoe}}}", run from any system that has
     92"{{{easy_install allmydata-tahoe}}}", on any system that has
    9493easy_install and setuptools installed, will download the latest release of
    95 Tahoe (and its dependencies, all found via PyPI), build everything, and
     94Tahoe-LAFS (and its dependencies, all found via PyPI), build everything, and
    9695install it into the standard place for python libraries on your system. On
    9796unix platforms this usually goes into {{{/usr/lib/python2.5/site-packages/}}}
     
    9998
    10099On Debian or Ubuntu linux systems, you can install pre-compiled packages by
    101 adding the allmydata.org APT repository to your {{{/etc/apt/sources.list}}}
     100adding the tahoe-lafs.org APT repository to your {{{/etc/apt/sources.list}}}
    102101and installing the "allmydata-tahoe" package. See DownloadDebianPackages for
    103102details.
     
    117116somewhere else on your system. This is the traditional meaning of "install".
    118117
    119 The "{{{setup.py install}}}" target will install Tahoe (but not its
     118The "{{{setup.py install}}}" target will install Tahoe-LAFS (and its
    120119dependencies) into the standard place for python libraries on your system: on
    121120Unix platforms this usually goes into {{{/usr/lib/python2.5/site-packages/}}}
    122121and {{{/usr/bin/tahoe}}} .
    123122
    124 The "{{{make install}}}" target is a wrapper around "{{{setup.py install}}}"
     123The "{{{make install}}}" Makefile target is a wrapper around "{{{setup.py install}}}"
    125124that uses {{{--single-version-externally-managed}}} to bypass the extra
    126125checking that setuptools does. This allows "{{{make install}}}"  to work the same way as traditional unix
     
    128127
    129128("{{{make install PREFIX=/usr/local}}}" does not currently work -- see #703.)
    130 
    131 TODO: There should be some way to use "{{{setup.py easy_install}}}" to install
    132 Tahoe '''and''' its dependencies into the system somewhere, but I haven't
    133 been able to figure out how.
    134129
    135130=== Creating a binary distribution From A Source Tree ===
     
    161156== Platform-specific Notes ==
    162157
    163 === Debian/Ubuntu ===
    164 
    165 Tahoe is primarily developed on Debian/Ubuntu machines. You can either build
     158=== !Debian/Ubuntu ===
     159
     160Tahoe-LAFS is primarily developed on !Debian/Ubuntu machines. You can either build
    166161from source (as described by this page), or download pre-compiled debian
    167162packages for several distributions. See the DownloadDebianPackages page for
     
    185180=== Windows ===
    186181
    187 The following procedure will install and run Tahoe on Windows.  Note that this assumes that you install Python in the default location (C:\Python26), if you choose another location you'll need to adjust the instructions below:
     182The following procedure will install and run Tahoe-LAFS on Windows.  Note that this assumes that you install Python in the default location (C:\Python26), if you choose another location you'll need to adjust the instructions below:
    188183
    1891841. Download and install Python 2.6.2 from http://www.python.org/ftp/python/2.6.2/python-2.6.2.msi.
     
    1911862. Download and install pywin32 from http://sourceforge.net/projects/pywin32/files/pywin32/Build%20214/pywin32-214.win32-py2.6.exe/download.
    192187
    193 3. Download the latest Tahoe snapshot from http://allmydata.org/source/tahoe/snapshots/. Unpack it in a convenient place, such as C:\tahoe.
    194 
    195 4. Open a command prompt and cd to the top of the Tahoe tree (e.g. {{{cd \tahoe}}}).
     1883. Download the latest Tahoe-LAFS snapshot from http://tahoe-lafs.org/source/tahoe-lafs/snapshots/. Unpack it in a convenient place, such as C:\tahoe-lafs.
     189
     1904. Open a command prompt and cd to the top of the Tahoe-LAFS tree (e.g. {{{cd \tahoe-lafs}}}).
    196191
    1971925. Run "{{{C:\Python26\python setup.py build}}}". Wait a bit until it stops working. Note that you need a working network connection because it will download various dependencies. Ignore any warnings referring to darcs.
     
    1991946. Run "{{{C:\Python26\python setup.py install}}}". Wait a bit until it stops working. Again, you may need a working network connection.
    200195
    201 7. Run "{{{C:\Python26\Scripts\tahoe create-client --basedir C:\tahoebase}}}".  Choose an appropriate base directory.
    202 
    203 8. Run "{{{notepad C:\tahoebase\tahoe.cfg}}}" to edit your config file. After "{{{introducer.furl = }}}", paste in the FURL of the introducer for the grid you want to connect to.  The test grid FURL is pb://todjw7qkb4dgq4fkeo7cqydcu5vneioh@tahoecs2.allmydata.com:52106/introducer .
    204 
    205 9. Run "{{{C:\Python26\Scripts\tahoe start --basedir C:\tahoebase}}}". Your node will start running and connect to the grid. The Windows firewall may ask whether or not to allow python to make network connections. Say yes.
     1967. Run "{{{C:\Python26\Scripts\tahoe create-client --basedir C:\tahoelafsbase}}}".  Choose an appropriate base directory.
     197
     1988. Run "{{{notepad C:\tahoelafsbase\tahoe.cfg}}}" to edit your config file. After "{{{introducer.furl = }}}", paste in the FURL of the introducer for the grid you want to connect to.  The test grid FURL is pb://todjw7qkb4dgq4fkeo7cqydcu5vneioh@tahoecs2.allmydata.com:52106/introducer .
     199
     2009. Run "{{{C:\Python26\Scripts\tahoe start --basedir C:\tahoelafsbase}}}". Your node will start running and connect to the grid. The Windows firewall may ask whether or not to allow python to make network connections. Say yes.
    206201
    207202=== What if that doesn't work? ===
     
    222217After installing the compilers, repeat the above instructions from step 4 (using a new command prompt to make sure that the environment variable setting has taken effect).
    223218
    224 If you prefer to use Python 2.5, you must install a 2.5 build of pywin32 and also install OpenSSL or Tahoe will fail to run with an error about being unable to find ssl.dll.  To install OpenSSL:
     219If you prefer to use Python 2.5, you must install a 2.5 build of pywin32 and also install OpenSSL or Tahoe-LAFS will fail to run with an error about being unable to find ssl.dll.  To install OpenSSL:
    225220
    2262211. Download and install the Visual Studio 2008 redistributables from  http://www.microsoft.com/downloads/details.aspx?familyid=9B2DA534-3E03-4391-8A4D-074B9F2BC1BF&displaylang=en. This is needed for OpenSSL.