ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-19 04:57:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
The Tahoe-LAFS decentralized secure filesystem.
343 Commits 185 Branches 89 Tags 89 MiB
Python 98.1%
HTML 0.9%
Nix 0.3%
Shell 0.3%
Makefile 0.2%
Other 0.1%
4b4f5bbcba
Go to file
Zooko O'Whielacronx 4b4f5bbcba change #!/usr/bin/python to #!/usr/bin/env python 
Note that using "whatever version of python the name 'python' maps to in the current shell environment" is more error-prone that specifying which python you mean, such as by executing "/usr/bin/python setup.py" instead of executing "./setup.py".  When you build tahoe (by running "make") it will make a copy of bin/allmydata-tahoe in instdir/bin/allmydata-tahoe with the shebang line rewritten to execute the specific version of python that was used when building instead of to execute "/usr/bin/env python".

However, it seems better that the default for lazy people be "whatever 'python' means currently" instead of "whatever 'python' meant to the manufacturer of your operating system".
2007-03-29 14:01:28 -07:00
bin change #!/usr/bin/python to #!/usr/bin/env python 2007-03-29 14:01:28 -07:00
dapper/debian debian: add python-twisted, python-nevow, python-pyopenssl to the dapper dependencies 2007-03-29 12:22:14 -07:00
docs add the 'Denver Airport' design doc, for Chord-based peer selection 2006-12-01 19:09:14 -07:00
misc change #!/usr/bin/python to #!/usr/bin/env python 2007-03-29 14:01:28 -07:00
pyfec pyfec: more thanks to Brian 2007-03-28 15:22:51 -07:00
sid/debian debian: add python-nevow to the sid dependencies 2007-03-29 12:22:41 -07:00
src change #!/usr/bin/python to #!/usr/bin/env python 2007-03-29 14:01:28 -07:00
twisted/plugins change #!/usr/bin/python to #!/usr/bin/env python 2007-03-29 14:01:28 -07:00
.darcs-boringfile more work on a memory-footprint test program 2007-03-12 16:28:37 -07:00
client.tac clients now get the queen's pburl from a file named roster_pburl, not hardcoded in the .tac file 2006-12-04 04:27:40 -07:00
Makefile start work on a memory-measuring test tool 2007-03-08 18:12:24 -07:00
MANIFEST.in add distutils-based packaging 2006-12-05 01:29:26 -07:00
queen.tac add beginning queen code 2006-11-30 15:39:24 -07:00
README tahoe readme - updated to included all packages and clarify text 2007-03-29 12:02:32 -07:00
roadmap.txt switch to pyfec 2007-03-28 00:05:16 -07:00
setup.py change #!/usr/bin/python to #!/usr/bin/env python 2007-03-29 14:01:28 -07:00
simulator.py change #!/usr/bin/python to #!/usr/bin/env python 2007-03-29 14:01:28 -07:00
sizes.py change #!/usr/bin/python to #!/usr/bin/env python 2007-03-29 14:01:28 -07:00

README 

Welcome to the AllMyData "tahoe" project. This project implements a
scalable distributed fault-tolerant filestore.

The main application code is in the 'allmydata' package, under src/allmydata/
. There is also a patched version of PyCrypto (adding a faster CTR-mode) in
src/Crypto/ which gets installed to the 'allmydata.Crypto' package (since the
API is different than the normal Crypto package). It also includes Zooko's
PyFEC library, a fast python wrapper around the Rizzo 'fec' C library,
installed to the 'pyfec' package and located in src/pyfec/ .

DEPENDENCIES:

 Python 2.4 or newer (tested against both 2.4 and 2.5)
  http://python.org/
 Twisted (probably 2.4.0 or newer)
  http://twistedmatrix.com/
  The default subpackages should all be included by default, but in
    case they aren't they are the following:
   * core (the standard Twisted package)
   * web, trial, conch
  Note that Twisted requires zope.interface, and that the standard
  batteries-included Twisted distribution includes a copy.
 Foolscap (probably 0.0.7 or newer)
  - note: since the Foolscap wire protocol is not yet compatible from one
    release to the next, make sure all of your nodes are using the same
    version of Foolscap
  http://twistedmatrix.com/trac/wiki/FoolsCap
 Nevow (probably 0.9.0 or later)
  http://divmod.org/trac/wiki/DivmodNevow
 PyOpenSSL (0.6 or later)
  http://pyopenssl.sourceforge.net

BUILDING:

 Just type 'make'. If the desired version of 'python' is not already on your
 $PATH, then type 'make PYTHON=/path/to/your/preferred/python'.

 'make test' runs the unit test suite.

 'make deb-dapper' or 'make deb-sid' will construct a debian package named
 'allmydata-tahoe'.

RUNNING:

 The installed package creates an 'allmydata-tahoe' executable, usually in
 /usr/bin . This tool is used to create, start, and stop nodes.

 Somewhere in your mesh there must be a central 'queen' node. This is
 constructed by running 'allmydata-tahoe create-queen --basedir WHERE'. Once
 constructed, you can start the queen by running 'allmydata-tahoe start
 --basedir WHERE'. 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.

 To construct a client node, pick a new working directory for it, then run
 'allmydata-tahoe create-client --basedir $HERE'. Copy the two .furl files
 from the queen into this new directory, then run 'allmydata-tahoe start
 --basedir $HERE'. After that, the client node should be off and running. The
 first thing it will do is connect to the queen and introduce itself to all
 other nodes on the mesh. You can follow its progress by looking at the
 $HERE/twistd.log file.

 To actually use the client, enable the web interface by writing a port
 number (like "8080") into a file named $HERE/webport and then restarting the
 node with 'allmydata-tahoe restart --basedir $HERE'. This will prompt the
 client node to run a webserver on the desired port, through which you can
 view, upload, download, and delete files.