mirror of
https://github.com/tahoe-lafs/tahoe-lafs.git
synced 2025-02-24 19:01:07 +00:00
new licences, move details from README to doc/install-details.html
This commit is contained in:
Zooko O'Whielacronx
parent
bf14613b6a
commit
49a9fddb1d
@ -1,11 +1,3 @@
|
||||
In addition to the terms of the GNU General Public License, this licence also
|
||||
comes with the added permission that, if you become obligated to release a
|
||||
derived work under this licence (as per section 2.b), you may delay the
|
||||
fulfillment of this obligation for up to 12 months ("grace period"). If you
|
||||
are obligated to release code under section 2.b of this licence, you are
|
||||
obligated to release it under these same terms, including the 12-month
|
||||
grace period clause.
|
||||
|
||||
This licence also comes with the added permission that you may link this
|
||||
program with the OpenSSL library and distribute executables, as long as you
|
||||
follow the requirements of this licence in regard to all of the software in
|
||||
48
COPYING.TGPPL
Normal file
48
COPYING.TGPPL
Normal file
@ -0,0 +1,48 @@
|
||||
|
||||
Transitive Grace Period Public Licence ("TGPPL") v. 1.0
|
||||
|
||||
This Transitive Grace Period Public Licence (the "License") applies to any original work of authorship (the "Original Work") whose owner (the "Licensor") has placed the following licensing notice adjacent to the copyright notice for the Original Work:
|
||||
|
||||
Licensed under the Transitive Grace Period Public Licence version 1.0
|
||||
|
||||
1. Grant of Copyright License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, for the duration of the copyright, to do the following:
|
||||
|
||||
1. to reproduce the Original Work in copies, either alone or as part of a collective work;
|
||||
|
||||
2. to translate, adapt, alter, transform, modify, or arrange the Original Work, thereby creating derivative works ("Derivative Works") based upon the Original Work;
|
||||
|
||||
3. to distribute or communicate copies of the Original Work and Derivative Works to the public, with the proviso that copies of Original Work or Derivative Works that You distribute or communicate shall be licensed under this Transitive Grace Period Public Licence no later than 12 months after You distributed or communicated said copies;
|
||||
|
||||
4. to perform the Original Work publicly; and
|
||||
|
||||
5. to display the Original Work publicly.
|
||||
|
||||
2. Grant of Patent License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, under patent claims owned or controlled by the Licensor that are embodied in the Original Work as furnished by the Licensor, for the duration of the patents, to make, use, sell, offer for sale, have made, and import the Original Work and Derivative Works.
|
||||
|
||||
3. Grant of Source Code License. The term "Source Code" means the preferred form of the Original Work for making modifications to it and all available documentation describing how to modify the Original Work. Licensor agrees to provide a machine-readable copy of the Source Code of the Original Work along with each copy of the Original Work that Licensor distributes. Licensor reserves the right to satisfy this obligation by placing a machine-readable copy of the Source Code in an information repository reasonably calculated to permit inexpensive and convenient access by You for as long as Licensor continues to distribute the Original Work.
|
||||
|
||||
4. Exclusions From License Grant. Neither the names of Licensor, nor the names of any contributors to the Original Work, nor any of their trademarks or service marks, may be used to endorse or promote products derived from this Original Work without express prior permission of the Licensor. Except as expressly stated herein, nothing in this License grants any license to Licensor's trademarks, copyrights, patents, trade secrets or any other intellectual property. No patent license is granted to make, use, sell, offer for sale, have made, or import embodiments of any patent claims other than the licensed claims defined in Section 2. No license is granted to the trademarks of Licensor even if such marks are included in the Original Work. Nothing in this License shall be interpreted to prohibit Licensor from licensing under terms different from this License any Original Work that Licensor otherwise would have a right to license.
|
||||
|
||||
5. External Deployment. The term "External Deployment" means the use, distribution, or communication of the Original Work or Derivative Works in any way such that the Original Work or Derivative Works may be used by anyone other than You, whether those works are distributed or communicated to those persons or made available as an application intended for use over a network. As an express condition for the grants of license hereunder, You must treat any External Deployment by You of the Original Work or a Derivative Work as a distribution under section 1(c).
|
||||
|
||||
6. Attribution Rights. You must retain, in the Source Code of any Derivative Works that You create, all copyright, patent, or trademark notices from the Source Code of the Original Work, as well as any notices of licensing and any descriptive text identified therein as an "Attribution Notice." You must cause the Source Code for any Derivative Works that You create to carry a prominent Attribution Notice reasonably calculated to inform recipients that You have modified the Original Work.
|
||||
|
||||
7. Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that the copyright in and to the Original Work and the patent rights granted herein by Licensor are owned by the Licensor or are sublicensed to You under the terms of this License with the permission of the contributor(s) of those copyrights and patent rights. Except as expressly stated in the immediately preceding sentence, the Original Work is provided under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without limitation, the warranties of non-infringement, merchantability or fitness for a particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential part of this License. No license to the Original Work is granted by this License except under this disclaimer.
|
||||
|
||||
8. Limitation of Liability. Under no circumstances and under no legal theory, whether in tort (including negligence), contract, or otherwise, shall the Licensor be liable to anyone for any indirect, special, incidental, or consequential damages of any character arising as a result of this License or the use of the Original Work including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses. This limitation of liability shall not apply to the extent applicable law prohibits such limitation.
|
||||
|
||||
9. Acceptance and Termination. If, at any time, You expressly assented to this License, that assent indicates your clear and irrevocable acceptance of this License and all of its terms and conditions. If You distribute or communicate copies of the Original Work or a Derivative Work, You must make a reasonable effort under the circumstances to obtain the express assent of recipients to the terms of this License. This License conditions your rights to undertake the activities listed in Section 1, including your right to create Derivative Works based upon the Original Work, and doing so without honoring these terms and conditions is prohibited by copyright law and international treaty. Nothing in this License is intended to affect copyright exceptions and limitations (including 'fair use' or 'fair dealing'). This License shall terminate immediately and You may no longer exercise any of the rights granted to You by this License upon your failure to honor the conditions in Section 1(c).
|
||||
|
||||
10. Termination for Patent Action. This License shall terminate automatically and You may no longer exercise any of the rights granted to You by this License as of the date You commence an action, including a cross-claim or counterclaim, against Licensor or any licensee alleging that the Original Work infringes a patent. This termination provision shall not apply for an action alleging patent infringement by combinations of the Original Work with other software or hardware.
|
||||
|
||||
11. Jurisdiction, Venue and Governing Law. Any action or suit relating to this License may be brought only in the courts of a jurisdiction wherein the Licensor resides or in which Licensor conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any use of the Original Work outside the scope of this License or after its termination shall be subject to the requirements and penalties of copyright or patent law in the appropriate jurisdiction. This section shall survive the termination of this License.
|
||||
|
||||
12. Attorneys' Fees. In any action to enforce the terms of this License or seeking damages relating thereto, the prevailing party shall be entitled to recover its costs and expenses, including, without limitation, reasonable attorneys' fees and costs incurred in connection with such action, including any appeal of such action. This section shall survive the termination of this License.
|
||||
|
||||
13. Miscellaneous. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable.
|
||||
|
||||
14. Definition of "You" in This License. "You" throughout this License, whether in upper or lower case, means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with you. For purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
15. Right to Use. You may use the Original Work in all ways not otherwise restricted or conditioned by this License or by law, and Licensor promises not to interfere with or be responsible for such uses by You.
|
||||
|
||||
16. Modification of This License. This License is Copyright \a9 2007 Zooko Wilcox-O'Hearn. Permission is granted to copy, distribute, or communicate this License without modification. Nothing in this License permits You to modify this License as applied to the Original Work or to Derivative Works. However, You may modify the text of this License and copy, distribute or communicate your modified version (the "Modified License") and apply it to other original works of authorship subject to the following conditions: (i) You may not indicate in any way that your Modified License is the "Transitive Grace Period Public Licence" or "TGPPL" and you may not use those names in the name of your Modified License; and (ii) You must replace the notice specified in the first paragraph above with the notice "Licensed under <insert your license name here>" or with a notice of your own that is not confusingly similar to the notice in this License.
|
||||
342
README
342
README
@ -11,339 +11,17 @@ See the web site for information, news, and discussion:
|
||||
http://allmydata.org
|
||||
|
||||
|
||||
DEPENDENCIES:
|
||||
INSTALLING
|
||||
|
||||
If you aren't getting a pre-compiled binary, then you'll have to ensure that
|
||||
the following packages are installed before you install Tahoe.
|
||||
See doc/install.html .
|
||||
|
||||
There are two kinds of dependencies, "manual dependencies" and
|
||||
"easy_install-able dependencies". The latter kind are normally automatically
|
||||
satisfied for you when you install Tahoe, but if something goes wrong, please
|
||||
see the EASY_INSTALLABLE DEPENDENCIES section below.
|
||||
|
||||
All of the manual dependencies can probably be installed through your
|
||||
standard package management tool if you are running on a modern Unix
|
||||
operating system. For example, on an debian-like system, you can do "sudo
|
||||
apt-get install build-essential python-dev python-twisted python-pyopenssl".
|
||||
LICENCE
|
||||
|
||||
The Manual Dependencies:
|
||||
|
||||
+ a C compiler (language)
|
||||
|
||||
+ GNU make (build tool)
|
||||
|
||||
+ Python 2.4 or newer (tested against 2.4.4, and 2.5.1 -- note that 2.4.1 is
|
||||
known not to work due to a bug in its base-32 encoder), including
|
||||
development headers i.e. "Python.h" (language)
|
||||
|
||||
http://python.org/
|
||||
|
||||
+ Twisted Python (tested against 2.2.0, 2.4.0, and 2.5.0) (network and
|
||||
operating system integration library)
|
||||
|
||||
http://twistedmatrix.com/
|
||||
|
||||
Installing from the Twisted source tarball works on all known supported
|
||||
platforms, including cygwin.
|
||||
|
||||
You need the following subpackages, which are included in the default
|
||||
Twisted distribution:
|
||||
|
||||
* core (the standard Twisted package)
|
||||
* web, trial, conch
|
||||
|
||||
Twisted requires that you manually install zope.interface, a copy of which
|
||||
is included in the Twisted distribution. Note that Twisted does *not*
|
||||
require the entire Zope distribution, merely the much smaller
|
||||
zope.interface component.
|
||||
|
||||
+ OpenSSL, including development headers (cryptography library)
|
||||
|
||||
http://openssl.org
|
||||
|
||||
+ Crypto++, including development headers (cryptography library)
|
||||
|
||||
http://cryptopp.com
|
||||
|
||||
+ Python PyOpenSSL (0.6 or later) (secure transport layer)
|
||||
|
||||
http://pyopenssl.sourceforge.net
|
||||
|
||||
To install PyOpenSSL on cygwin, install the OpenSSL development libraries
|
||||
with the cygwin package management tool, then get the pyOpenSSL source
|
||||
code, cd into it, and run "python ./setup.py install".
|
||||
|
||||
|
||||
GETTING THE SOURCE CODE:
|
||||
|
||||
You need the source code if you are going to install The Debian Way, The
|
||||
Setuptools Way, or The Running-In-Place Way (see below). You do not need the
|
||||
source code if you are getting precompiled binaries for Debian or Ubuntu (see
|
||||
above), or if you are going to install The easy_install Way (see below).
|
||||
|
||||
The code is available via darcs by running the following command:
|
||||
|
||||
darcs get http://allmydata.org/source/tahoe/trunk tahoe
|
||||
|
||||
This will create a directory named "tahoe" in the current working directory
|
||||
and put a copy of the latest source code into it. Later, if you want to get
|
||||
any new changes, then cd into that directory and run the command "darcs
|
||||
pull".
|
||||
|
||||
Tarballs of sources are available at:
|
||||
|
||||
http://allmydata.org/source/tahoe/
|
||||
|
||||
|
||||
INSTALLING:
|
||||
|
||||
There are four ways to do it: The easy_install Way, The Setuptools Way, The
|
||||
Running-In-Place Way, and The Debian Way. Choose one. If you're not sure,
|
||||
choose the easy_install way.
|
||||
|
||||
The easy_install Way:
|
||||
|
||||
You don't need to download the source code first. You do need to have the
|
||||
"easy_install" tool installed first:
|
||||
|
||||
http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install
|
||||
|
||||
The 'easy_install' tool can download and install tahoe for you. Just type
|
||||
'easy_install allmydata-tahoe' from any shell. That will download the most
|
||||
recent Tahoe source tarball, unpack it in a temporary directory, install it
|
||||
to the standard location, then download and install any easy_install-able
|
||||
dependencies that you need (setuptools, zfec, foolscap, simplejson, nevow,
|
||||
and pycryptopp). (This will work only if you have already installed the
|
||||
dependencies listed in the MANUAL DEPENDENCIES section, above.)
|
||||
|
||||
The end result will be that the Tahoe code is installed to the standard
|
||||
location for libraries on your operating system (on unix, that is somewhere
|
||||
inside /usr/lib/), and the "tahoe" executable will be installed to the
|
||||
standard location for executables on operating system.
|
||||
|
||||
The Setuptools Way:
|
||||
|
||||
Get the source code (see above).
|
||||
|
||||
Run 'python setup.py install'. This will compile and install the Tahoe code
|
||||
to the standard location for your operating system (on unix, that is
|
||||
somewhere inside /usr/lib/). It will also acquire and install the
|
||||
easy_install-able dependencies (setuptools, zfec, foolscap, simplejson,
|
||||
nevow, and pycryptopp) to the same place. (This will work only if you have
|
||||
already installed the dependencies listed in the MANUAL DEPENDENCIES
|
||||
section, above.)
|
||||
|
||||
(To install it to a non-standard location, see
|
||||
http://allmydata.org/trac/tahoe/wiki/SetuptoolsAndGNUStow .)
|
||||
|
||||
The end result will be that the Tahoe code is installed to the standard
|
||||
location for libraries on your operating system (on unix, that is somewhere
|
||||
inside /usr/lib/), and the "tahoe" executable will be installed to the
|
||||
standard location for executables on operating system.
|
||||
|
||||
The Running-In-Place Way:
|
||||
|
||||
You can use Tahoe without installing it. The steps are these:
|
||||
|
||||
1. Get the source code (see above).
|
||||
|
||||
2. Run "make build-auto-deps" to install the easy_install-able dependencies
|
||||
(setuptools, zfec, foolscap, simplejson, nevow, and pycryptopp) into a
|
||||
local subdirectory of the Tahoe source distribution. (Note that when the
|
||||
dependent libraries are updated, you should use "make clean" before
|
||||
"make build-auto-deps" to make sure you will get the newest versions).
|
||||
|
||||
3. Build Tahoe by running "make".
|
||||
|
||||
4. Once you've built it then you can execute "./bin/tahoe". (When the tahoe
|
||||
script is in a Tahoe source distribution, it adds the necessary
|
||||
directory to the Python "sys.path". It also looks for any dependencies
|
||||
that you installed by "make build-auto-deps" and includes them in the
|
||||
sys.path.) See the RUNNING section, below.
|
||||
|
||||
The Debian Way:
|
||||
|
||||
The Debian Way is to build .deb files which you can then install with
|
||||
"dpkg".
|
||||
|
||||
This requires certain debian packages (build-essential, fakeroot,
|
||||
devscripts, debhelper, cdbs) to be installed first, since they are used to
|
||||
construct the Tahoe .deb files. A full list of these required packages can
|
||||
be found in the "Build-Depends" line in the misc/DIST/debian/control in the
|
||||
top-level tahoe directory (replacing the word DIST with etch, dapper, edgy,
|
||||
or feisty as appropriate).
|
||||
|
||||
Get the source code (see above).
|
||||
|
||||
If you're running on a debian system, run 'make deb-etch', 'make deb-sid',
|
||||
'make deb-edgy', or 'make deb-feisty' from within the tahoe top-level
|
||||
directory to construct a debian package named 'allmydata-tahoe' which you
|
||||
can then install with dpkg.
|
||||
|
||||
|
||||
TESTING THAT IT IS PROPERLY INSTALLED
|
||||
|
||||
If you have gotten the source code, then you can run 'make check-deps'
|
||||
checks that all of the required Python package dependencies are installed.
|
||||
You can run 'make test' runs the unit test suites. (This can take a long
|
||||
time on slow computers. There are a lot of tests and some of them do a lot
|
||||
of public-key cryptography.)
|
||||
|
||||
Executing the tahoe script from the "bin" subdirectory will work only if
|
||||
Tahoe itself is installed, either because it is installed into the local
|
||||
subdirectory (as per "The Running-In-Place Way") or because it is installed
|
||||
into your system (as per the other three ways of installing).
|
||||
|
||||
|
||||
RUNNING:
|
||||
|
||||
Run the "tahoe" executable.
|
||||
|
||||
If you installed "The Running-In-Place Way", then it is in your source tree,
|
||||
in the "bin" subdirectory thereof. If you installed in one of the other
|
||||
three ways, then it has been installed into your operating system's
|
||||
filesystem, perhaps in "/usr/bin" on Unix, or in "C:\Python25\Scripts" on
|
||||
Window.
|
||||
|
||||
The "tahoe" utility is used to create, start, and stop nodes. Each node
|
||||
lives in a separate base directory, inside of which you can add files to
|
||||
configure and control the node. Nodes also read and write files within that
|
||||
directory.
|
||||
|
||||
A grid consists of a single central 'introducer and vdrive' node and one or
|
||||
more 'client' nodes. If you are joining an existing grid, the
|
||||
introducer-and-vdrive node will already be running, and you'll just need to
|
||||
create a client node. If you're creating a brand new grid, you'll need to
|
||||
create both an introducer-and-vdrive and a client (and then invite other
|
||||
people to create their own client nodes and join your grid).
|
||||
|
||||
The introducer (-and-vdrive) node is constructed by running 'tahoe
|
||||
create-introducer --basedir $HERE'. Once constructed, you can start the
|
||||
introducer by running 'tahoe start --basedir $HERE' (or, if you are already
|
||||
in the introducer's base directory, just type 'tahoe start'). Inside that
|
||||
base directory, there will be a pair of files 'introducer.furl' and
|
||||
'vdrive.furl'. Make a copy of these, as they'll be needed on the client
|
||||
nodes. (If you want to use a publically available test grid, get the
|
||||
introducer.furl and vdrive.furl files from
|
||||
http://allmydata.org/trac/tahoe/wiki/TestGrid instead of running your own
|
||||
introducer.)
|
||||
|
||||
To construct a client node, pick a new working directory for it, then run
|
||||
'tahoe create-client --basedir $HERE'. Copy the two .furl files from the
|
||||
introducer into this new directory, then run 'tahoe start --basedir $HERE'.
|
||||
After that, the client node should be off and running. The first thing it
|
||||
will do is connect to the introducer and introduce itself to all other nodes
|
||||
on the grid. You can follow its progress by looking at the
|
||||
$HERE/logs/twistd.log file.
|
||||
|
||||
create-client will put port specification into a file named $HERE/webport,
|
||||
unless overridden by the --webport option to create-client. The presence of
|
||||
a port specification in the webport file prompts the client node to run a
|
||||
webserver on the desired port, through which you can view, upload, download,
|
||||
and delete files. The contents of the webport file is actually a "strports
|
||||
specification", defined in
|
||||
http://twistedmatrix.com/documents/current/api/twisted.application.strports.html
|
||||
, so you can have it only listen on a local interface by writing
|
||||
"tcp:8123:interface=127.0.0.1" to this file (that's what create-client does
|
||||
by default), or make it use SSL by writing
|
||||
"ssl:8123:privateKey=mykey.pem:certKey=cert.pem" instead.
|
||||
|
||||
A client node directory can also be created without installing the code
|
||||
first. Just use 'make create-client', and a new directory named 'CLIENTDIR'
|
||||
will be created inside the top of the source tree. Copy the relevant .furl
|
||||
files in, set the webport, then start the node by using 'make start-client'.
|
||||
To stop it again, use 'make stop-client'. Similar makefile targets exist
|
||||
for making and running an introducer node.
|
||||
|
||||
If you are behind a firewall and you can configure your firewall to forward
|
||||
TCP connections on a port to the computer running your Tahoe node, then you
|
||||
can configure the Tahoe node to announce itself as being available on that
|
||||
IP address and port. The way to do this is to create a file named
|
||||
$HERE/advertised_ip_addresses, in which you can put IP addresses and port
|
||||
numbers in "dotted-quad:port" form, e.g. "209.97.232.113:1345". You can put
|
||||
multiple IP-address-and-port-number entries into this file, on separate
|
||||
lines.
|
||||
|
||||
There is a public grid available for testing. The necessary .furl files are
|
||||
in docs/testgrid/*.furl . More information is available on
|
||||
http://allmydata.org/trac/tahoe/wiki/TestGrid .
|
||||
|
||||
|
||||
LICENCE:
|
||||
|
||||
This program is free software; you can redistribute it and/or modify it
|
||||
under the terms of the GNU General Public License as published by the Free
|
||||
Software Foundation; either version 2 of the License, or (at your option)
|
||||
any later version, with the added permission that, if you become obligated
|
||||
to release a derived work under this licence (as per section 2.b), you may
|
||||
delay the fulfillment of this obligation for up to 12 months. If you are
|
||||
obligated to release code under section 2.b of this licence, you are
|
||||
obligated to release it under these same terms, including the 12-month grace
|
||||
period clause. See the COPYING file for details.
|
||||
|
||||
|
||||
EASY_INSTALLABLE DEPENDENCIES
|
||||
|
||||
The following Python packages are required, but normally they are
|
||||
automatically installed as a side-effect of installing Tahoe.
|
||||
|
||||
+ Python setuptools (build and distribution tool)
|
||||
|
||||
http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions
|
||||
|
||||
The Tahoe install process will automatically download and install
|
||||
setuptools if it is not present. However, if an old, incompatible version
|
||||
of setuptools is present (< v0.6c6 on Cygwin, or < v0.6a9 on other
|
||||
platforms), then the install will fail.
|
||||
|
||||
If the install fails due to your current version of setuptools being
|
||||
incompatible, please either upgrade or uninstall your version of
|
||||
setuptools and re-run the install.
|
||||
|
||||
+ zfec (1.0.3 or later) (erasure coding library)
|
||||
|
||||
http://cheeseshop.python.org/pypi/zfec
|
||||
|
||||
zfec is packaged in a setuptools-compatible way and included in the Python
|
||||
Package Index (PyPI), so it will be automatically installed when you
|
||||
install Tahoe (see INSTALLING). It can be manually installed by running
|
||||
"easy_install zfec".
|
||||
|
||||
+ Python foolscap (0.2.3 or later) (secure remote object library)
|
||||
|
||||
http://cheeseshop.python.org/pypi/foolscap
|
||||
|
||||
foolscape is packaged in a setuptools-compatible way and included in the
|
||||
Python Package Index (PyPI), so it will be automatically installed when
|
||||
you install Tahoe (see INSTALLING). It can be manually installed by
|
||||
running "easy_install foolscap".
|
||||
|
||||
+ Python simplejson (1.4 or later) (JSON parser)
|
||||
|
||||
http://cheeseshop.python.org/pypi/simplejson
|
||||
|
||||
simplejson is packaged in a setuptools-compatible way and included in the
|
||||
Python Package Index (PyPI), so it will be automatically installed when
|
||||
you install Tahoe (see INSTALLING). It can be manually installed by
|
||||
running "easy_install simplejson".
|
||||
|
||||
+ Python Nevow (0.6.0 or later) (web presentation language)
|
||||
|
||||
http://divmod.org/trac/wiki/DivmodNevow
|
||||
|
||||
Note that the current version of Nevow (0.9.18) requires Twisted 2.4.0 or
|
||||
later.
|
||||
|
||||
Nevow is packaged in a setuptools-compatible way and included in the
|
||||
Python Package Index (PyPI), so it will be automatically installed when
|
||||
you install Tahoe (see INSTALLING). It can be manually installed by
|
||||
running "easy_install nevow".
|
||||
|
||||
+ Python pycryptopp (0.2.8 or later) (Python crypto library)
|
||||
|
||||
http://pypi.python.org/pypi/pycryptopp
|
||||
|
||||
pycryptopp is packaged in a setuptools-compatible way and included in the
|
||||
Python Package Index (PyPI), so it will be automatically installed when
|
||||
you install Tahoe (see INSTALLING). It can be manually installed by
|
||||
running "easy_install pycryptopp".
|
||||
You may use this package under the GNU General Public License, version 2 or, at
|
||||
your option, any later version. You may use this package under the Transitive
|
||||
Grace Period Public Licence, version 1.0. (You may choose to use this package
|
||||
under the terms of either licence, at your option.) See the file COPYING.GPL
|
||||
for the terms of the GNU General Public License, version 2. See the file
|
||||
COPYING.TGPPL for the terms of the Transitive Grace Period Public Licence,
|
||||
version 1.0.
|
||||
|
||||
@ -1,3 +1,264 @@
|
||||
DEPENDENCIES:
|
||||
|
||||
If you aren't getting a pre-compiled binary, then you'll have to ensure that
|
||||
the following packages are installed before you install Tahoe.
|
||||
|
||||
There are two kinds of dependencies, "manual dependencies" and
|
||||
"easy_install-able dependencies". The latter kind are normally automatically
|
||||
satisfied for you when you install Tahoe, but if something goes wrong, please
|
||||
see the EASY_INSTALLABLE DEPENDENCIES section below.
|
||||
|
||||
All of the manual dependencies can probably be installed through your
|
||||
standard package management tool if you are running on a modern Unix
|
||||
operating system. For example, on an debian-like system, you can do "sudo
|
||||
apt-get install build-essential python-dev python-twisted python-pyopenssl".
|
||||
|
||||
The Manual Dependencies:
|
||||
|
||||
+ a C compiler (language)
|
||||
|
||||
+ GNU make (build tool)
|
||||
|
||||
+ Python 2.4 or newer (tested against 2.4.4, and 2.5.1 -- note that 2.4.1 is
|
||||
known not to work due to a bug in its base-32 encoder), including
|
||||
development headers i.e. "Python.h" (language)
|
||||
|
||||
http://python.org/
|
||||
|
||||
+ Twisted Python (tested against 2.2.0, 2.4.0, and 2.5.0) (network and
|
||||
operating system integration library)
|
||||
|
||||
http://twistedmatrix.com/
|
||||
|
||||
Installing from the Twisted source tarball works on all known supported
|
||||
platforms, including cygwin.
|
||||
|
||||
You need the following subpackages, which are included in the default
|
||||
Twisted distribution:
|
||||
|
||||
* core (the standard Twisted package)
|
||||
* web, trial, conch
|
||||
|
||||
Twisted requires that you manually install zope.interface, a copy of which
|
||||
is included in the Twisted distribution. Note that Twisted does *not*
|
||||
require the entire Zope distribution, merely the much smaller
|
||||
zope.interface component.
|
||||
|
||||
+ OpenSSL, including development headers (cryptography library)
|
||||
|
||||
http://openssl.org
|
||||
|
||||
+ Crypto++, including development headers (cryptography library)
|
||||
|
||||
http://cryptopp.com
|
||||
|
||||
+ Python PyOpenSSL (0.6 or later) (secure transport layer)
|
||||
|
||||
http://pyopenssl.sourceforge.net
|
||||
|
||||
To install PyOpenSSL on cygwin, install the OpenSSL development libraries
|
||||
with the cygwin package management tool, then get the pyOpenSSL source
|
||||
code, cd into it, and run "python ./setup.py install".
|
||||
|
||||
|
||||
|
||||
xxx
|
||||
|
||||
|
||||
GETTING THE SOURCE CODE:
|
||||
|
||||
You need the source code if you are going to install The Debian Way, The
|
||||
Setuptools Way, or The Running-In-Place Way (see below). You do not need the
|
||||
source code if you are getting precompiled binaries for Debian or Ubuntu (see
|
||||
above), or if you are going to install The easy_install Way (see below).
|
||||
|
||||
The code is available via darcs by running the following command:
|
||||
|
||||
darcs get http://allmydata.org/source/tahoe/trunk tahoe
|
||||
|
||||
This will create a directory named "tahoe" in the current working directory
|
||||
and put a copy of the latest source code into it. Later, if you want to get
|
||||
any new changes, then cd into that directory and run the command "darcs
|
||||
pull".
|
||||
|
||||
Tarballs of sources are available at:
|
||||
|
||||
http://allmydata.org/source/tahoe/
|
||||
|
||||
|
||||
INSTALLING:
|
||||
|
||||
There are four ways to do it: The easy_install Way, The Setuptools Way, The
|
||||
Running-In-Place Way, and The Debian Way. Choose one. If you're not sure,
|
||||
choose the easy_install way.
|
||||
|
||||
The easy_install Way:
|
||||
|
||||
You don't need to download the source code first. You do need to have the
|
||||
"easy_install" tool installed first:
|
||||
|
||||
http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install
|
||||
|
||||
The 'easy_install' tool can download and install tahoe for you. Just type
|
||||
'easy_install allmydata-tahoe' from any shell. That will download the most
|
||||
recent Tahoe source tarball, unpack it in a temporary directory, install it
|
||||
to the standard location, then download and install any easy_install-able
|
||||
dependencies that you need (setuptools, zfec, foolscap, simplejson, nevow,
|
||||
and pycryptopp). (This will work only if you have already installed the
|
||||
dependencies listed in the MANUAL DEPENDENCIES section, above.)
|
||||
|
||||
The end result will be that the Tahoe code is installed to the standard
|
||||
location for libraries on your operating system (on unix, that is somewhere
|
||||
inside /usr/lib/), and the "tahoe" executable will be installed to the
|
||||
standard location for executables on operating system.
|
||||
|
||||
The Setuptools Way:
|
||||
|
||||
Get the source code (see above).
|
||||
|
||||
Run 'python setup.py install'. This will compile and install the Tahoe code
|
||||
to the standard location for your operating system (on unix, that is
|
||||
somewhere inside /usr/lib/). It will also acquire and install the
|
||||
easy_install-able dependencies (setuptools, zfec, foolscap, simplejson,
|
||||
nevow, and pycryptopp) to the same place. (This will work only if you have
|
||||
already installed the dependencies listed in the MANUAL DEPENDENCIES
|
||||
section, above.)
|
||||
|
||||
(To install it to a non-standard location, see
|
||||
http://allmydata.org/trac/tahoe/wiki/SetuptoolsAndGNUStow .)
|
||||
|
||||
The end result will be that the Tahoe code is installed to the standard
|
||||
location for libraries on your operating system (on unix, that is somewhere
|
||||
inside /usr/lib/), and the "tahoe" executable will be installed to the
|
||||
standard location for executables on operating system.
|
||||
|
||||
The Running-In-Place Way:
|
||||
|
||||
You can use Tahoe without installing it. The steps are these:
|
||||
|
||||
1. Get the source code (see above).
|
||||
|
||||
2. Run "make build-auto-deps" to install the easy_install-able dependencies
|
||||
(setuptools, zfec, foolscap, simplejson, nevow, and pycryptopp) into a
|
||||
local subdirectory of the Tahoe source distribution. (Note that when the
|
||||
dependent libraries are updated, you should use "make clean" before
|
||||
"make build-auto-deps" to make sure you will get the newest versions).
|
||||
|
||||
3. Build Tahoe by running "make".
|
||||
|
||||
4. Once you've built it then you can execute "./bin/tahoe". (When the tahoe
|
||||
script is in a Tahoe source distribution, it adds the necessary
|
||||
directory to the Python "sys.path". It also looks for any dependencies
|
||||
that you installed by "make build-auto-deps" and includes them in the
|
||||
sys.path.) See the RUNNING section, below.
|
||||
|
||||
The Debian Way:
|
||||
|
||||
The Debian Way is to build .deb files which you can then install with
|
||||
"dpkg".
|
||||
|
||||
This requires certain debian packages (build-essential, fakeroot,
|
||||
devscripts, debhelper, cdbs) to be installed first, since they are used to
|
||||
construct the Tahoe .deb files. A full list of these required packages can
|
||||
be found in the "Build-Depends" line in the misc/DIST/debian/control in the
|
||||
top-level tahoe directory (replacing the word DIST with etch, dapper, edgy,
|
||||
or feisty as appropriate).
|
||||
|
||||
Get the source code (see above).
|
||||
|
||||
If you're running on a debian system, run 'make deb-etch', 'make deb-sid',
|
||||
'make deb-edgy', or 'make deb-feisty' from within the tahoe top-level
|
||||
directory to construct a debian package named 'allmydata-tahoe' which you
|
||||
can then install with dpkg.
|
||||
|
||||
|
||||
TESTING THAT IT IS PROPERLY INSTALLED
|
||||
|
||||
If you have gotten the source code, then you can run 'make check-deps'
|
||||
checks that all of the required Python package dependencies are installed.
|
||||
You can run 'make test' runs the unit test suites. (This can take a long
|
||||
time on slow computers. There are a lot of tests and some of them do a lot
|
||||
of public-key cryptography.)
|
||||
|
||||
Executing the tahoe script from the "bin" subdirectory will work only if
|
||||
Tahoe itself is installed, either because it is installed into the local
|
||||
subdirectory (as per "The Running-In-Place Way") or because it is installed
|
||||
into your system (as per the other three ways of installing).
|
||||
|
||||
|
||||
RUNNING:
|
||||
|
||||
Run the "tahoe" executable.
|
||||
|
||||
If you installed "The Running-In-Place Way", then it is in your source tree,
|
||||
in the "bin" subdirectory thereof. If you installed in one of the other
|
||||
three ways, then it has been installed into your operating system's
|
||||
filesystem, perhaps in "/usr/bin" on Unix, or in "C:\Python25\Scripts" on
|
||||
Window.
|
||||
|
||||
The "tahoe" utility is used to create, start, and stop nodes. Each node
|
||||
lives in a separate base directory, inside of which you can add files to
|
||||
configure and control the node. Nodes also read and write files within that
|
||||
directory.
|
||||
|
||||
A grid consists of a single central 'introducer and vdrive' node and one or
|
||||
more 'client' nodes. If you are joining an existing grid, the
|
||||
introducer-and-vdrive node will already be running, and you'll just need to
|
||||
create a client node. If you're creating a brand new grid, you'll need to
|
||||
create both an introducer-and-vdrive and a client (and then invite other
|
||||
people to create their own client nodes and join your grid).
|
||||
|
||||
The introducer (-and-vdrive) node is constructed by running 'tahoe
|
||||
create-introducer --basedir $HERE'. Once constructed, you can start the
|
||||
introducer by running 'tahoe start --basedir $HERE' (or, if you are already
|
||||
in the introducer's base directory, just type 'tahoe start'). Inside that
|
||||
base directory, there will be a pair of files 'introducer.furl' and
|
||||
'vdrive.furl'. Make a copy of these, as they'll be needed on the client
|
||||
nodes. (If you want to use a publically available test grid, get the
|
||||
introducer.furl and vdrive.furl files from
|
||||
http://allmydata.org/trac/tahoe/wiki/TestGrid instead of running your own
|
||||
introducer.)
|
||||
|
||||
To construct a client node, pick a new working directory for it, then run
|
||||
'tahoe create-client --basedir $HERE'. Copy the two .furl files from the
|
||||
introducer into this new directory, then run 'tahoe start --basedir $HERE'.
|
||||
After that, the client node should be off and running. The first thing it
|
||||
will do is connect to the introducer and introduce itself to all other nodes
|
||||
on the grid. You can follow its progress by looking at the
|
||||
$HERE/logs/twistd.log file.
|
||||
|
||||
create-client will put port specification into a file named $HERE/webport,
|
||||
unless overridden by the --webport option to create-client. The presence of
|
||||
a port specification in the webport file prompts the client node to run a
|
||||
webserver on the desired port, through which you can view, upload, download,
|
||||
and delete files. The contents of the webport file is actually a "strports
|
||||
specification", defined in
|
||||
http://twistedmatrix.com/documents/current/api/twisted.application.strports.html
|
||||
, so you can have it only listen on a local interface by writing
|
||||
"tcp:8123:interface=127.0.0.1" to this file (that's what create-client does
|
||||
by default), or make it use SSL by writing
|
||||
"ssl:8123:privateKey=mykey.pem:certKey=cert.pem" instead.
|
||||
|
||||
A client node directory can also be created without installing the code
|
||||
first. Just use 'make create-client', and a new directory named 'CLIENTDIR'
|
||||
will be created inside the top of the source tree. Copy the relevant .furl
|
||||
files in, set the webport, then start the node by using 'make start-client'.
|
||||
To stop it again, use 'make stop-client'. Similar makefile targets exist
|
||||
for making and running an introducer node.
|
||||
|
||||
If you are behind a firewall and you can configure your firewall to forward
|
||||
TCP connections on a port to the computer running your Tahoe node, then you
|
||||
can configure the Tahoe node to announce itself as being available on that
|
||||
IP address and port. The way to do this is to create a file named
|
||||
$HERE/advertised_ip_addresses, in which you can put IP addresses and port
|
||||
numbers in "dotted-quad:port" form, e.g. "209.97.232.113:1345". You can put
|
||||
multiple IP-address-and-port-number entries into this file, on separate
|
||||
lines.
|
||||
|
||||
There is a public grid available for testing. The necessary .furl files are
|
||||
in docs/testgrid/*.furl . More information is available on
|
||||
http://allmydata.org/trac/tahoe/wiki/TestGrid .
|
||||
|
||||
|
||||
The code is retrievable using the <a href="http://darcs.net">darcs</a>
|
||||
revision control tool by running the following command:
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user