tahoe-lafs/trac-2024-07-25
2
0
Issues 1.1k Wiki Activity

explain my strategy about quickstart.html+binary-eggs vs. AdvancedInstall 

[Imported from Trac: page Packaging, version 18]
zooko 2010-09-18 09:32:11 +00:00
parent 4c7f5bd39d
commit 6488f310a3
1 changed files with 31 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
Packaging.md

@ -1,5 +1,33 @@
*Attention: this page is for Tahoe-LAFS developers. If you are not a Tahoe-LAFS developer, then the page you want is <http://tahoe-lafs.org/source/tahoe-lafs/trunk/docs/quickstart.html> .*
# Packaging
## quickstart.html
The setup method that we offer to people when we don't know what platform they are setting up on or what level of expertise they have is "the quickstart.html method". This method starts by giving them a link to <http://tahoe-lafs.org/source/tahoe-lafs/trunk/docs/quickstart.html> .
* The quickstart.html is intended to be as platform-independent as possible--the only mention of a specific platform is that the dependency on "pywin32" can't be satisfied automatically (#142).
* The quickstart.html should *not* instruct the user to install any dependency if the build system could instead satisfy that dependency automatically (currently, as of 2010-09-18, the only dependencies that can't be satisfied automatically are python, and pywin32 which is needed only on Windows).
* The quickstart.html is intended to be as simple as possible. Options (you can do it this way or that way as you prefer) or branches (if you are in this situation do this, else do that) are strongly discouraged from being written into quickstart.html. If at all possible, please move those to [AdvancedInstall](AdvancedInstall).
### binary .egg's of dependency native-code packages
For quickstart.html to work on your platform there *must* exist a binary .egg for your platform of every dependency which has a native-code extension module. Currently those are: pycryptopp, zfec, pywin32, and [PyCrypto](PyCrypto). If there is not a binary .egg available of one of those packages for a given platform then this is a bug which prevents quickstart.html from working on that platform. (Note: if you already had that Python package installed on your system then you would be able to setup Tahoe-LAFS even if there is not a binary egg of that Python package available, e.g. if you manually installed the package already or if you installed the package already using an operating system packaging tool like apt-get. Nonetheless, since we can't rely on the user having done that and since quickstart.html cannot instruct the user to do that (see the section about quickstart.html above), then the absence of a binary .egg of a dependency for a platform is a bug preventing quickstart.html from working on that platform.
## [AdvancedInstall](AdvancedInstall)
Another installation method, alternative to quickstart.html, is [AdvancedInstall](AdvancedInstall). This method would be appropriate for people who prefer for the setup to be done differently than the way quickstart.html works. It is also the fallback for people who have tried quickstart.html and it didn't work (although the fact that quickstart.html didn't work should also be treated as a build process bug even if falling back to [AdvancedInstall](AdvancedInstall) allows the user to proceed).
## pre-built Debian packages
See [DownloadDebianPackages](DownloadDebianPackages).
## as shipped by Ubuntu
Tahoe-LAFS comes with Ubuntu. See <http://packages.ubuntu.com/lucid/tahoe-lafs> .
## desiderata
We want to package Tahoe-LAFS for people to download and use and we want to use
3rd-party libraries. The following are our current desiderata:
@ -16,7 +44,7 @@ We want to package Tahoe-LAFS for people to download and use and we want to use
deb http://allmydata.org/debian $DIST main tahoe
```
For libraries that Tahoe uses, we have these desiderata:
For libraries that Tahoe-LAFS uses, we have these desiderata:
* We use the source code as it is written by upstream. That is: no patching
required.
@ -28,13 +56,13 @@ For libraries that Tahoe uses, we have these desiderata:
* The user doesn't have to manually resolve any conflicts (this means that
we either have to automatically use a 3rd-party library if it is already
installed or else we have to automatically force Tahoe to use the copy
installed or else we have to automatically force Tahoe-LAFS to use the copy
that it came bundled with).
* Make it convenient for someone to use other versions of the packages that
we use e.g. system-wide packages or newer or alternate versions, etc..
* Bundle required libraries with the Tahoe distribution so that if someone
* Bundle required libraries with the Tahoe-LAFS distribution so that if someone
downloads the distribution, moves to a desert island without a net
connection, and then installs, it works.