viff

changeset 823:5e38146b499a

Updated installation guide with link to PyOpenSSL.
author Martin Geisler <mg@daimi.au.dk>
date Sat, 12 Jul 2008 20:00:51 +0200
parents 4caf0ba0f517
children b1438b77e4d6
files doc/install.txt
diffstat 1 files changed, 13 insertions(+), 23 deletions(-) [+]
line diff
     1.1 --- a/doc/install.txt	Sat Jul 12 19:46:01 2008 +0200
     1.2 +++ b/doc/install.txt	Sat Jul 12 20:00:51 2008 +0200
     1.3 @@ -5,13 +5,13 @@
     1.4  ==================
     1.5  
     1.6  VIFF is written in Python and uses the Twisted framework for
     1.7 -asynchronous communication, (optionally) python-gnutls for secure
     1.8 +asynchronous communication, (optionally) PyOpenSSL for secure
     1.9  communication, ConfigObj for configuration files, and GMPY for fast
    1.10  bignum arithmetic. You can find these components here:
    1.11  
    1.12  :Python:         http://python.org/
    1.13  :Twisted:        http://twistedmatrix.com/
    1.14 -:python-gnutls:  http://pypi.python.org/pypi/python-gnutls/
    1.15 +:PyOpenSSL:      http://pyopenssl.sourceforge.net/
    1.16  :ConfigObj:      http://voidspace.org.uk/python/configobj.html
    1.17  :GMPY:           http://code.google.com/p/gmpy/
    1.18  
    1.19 @@ -19,7 +19,7 @@
    1.20  
    1.21  :Python:         2.4.1 and 2.5.0
    1.22  :Twisted:        2.5.0 (there are `problems with 8.0.1`_)
    1.23 -:python-gnutls:  1.1.4
    1.24 +:PyOpenSSL:      0.7
    1.25  :ConfigObj:      4.4.0
    1.26  :GMPY:           1.0alpha and 1.0.2
    1.27  
    1.28 @@ -56,11 +56,8 @@
    1.29  5) Download and install GMPY_. If you are using Vista, right-click on
    1.30     the installer and choose the option to run as administrator.
    1.31  
    1.32 -6) In order to secure the channels between the players using TLS, you
    1.33 -   need to download and install python-gnutls_. However, we haven't
    1.34 -   had the time to test installation of this on Windows yet. Feel free
    1.35 -   to contribute with details about this by sending an email to the
    1.36 -   `VIFF mailing list`_.
    1.37 +6) Download and install PyOpenSSL_. Again, run the installer as
    1.38 +   adminitrator if you are using Vista.
    1.39  
    1.40  7) Download and install VIFF_. Note that if you are using the
    1.41     installer on Vista, you will again need to run it as an
    1.42 @@ -85,12 +82,7 @@
    1.43  
    1.44        PATH="/Library/Python/2.5/site-packages:${PATH}"
    1.45  
    1.46 -3) You can skip this step if you do not want secure connections.
    1.47 -   Otherwise install python-gnutls_:
    1.48 -
    1.49 -   a) Install XCode_ from Apple which provides the GCC compiler.
    1.50 -   b) Install gnutls_ (and required packages) from source.
    1.51 -   c) Install python-gnutls_.
    1.52 +3) Optionally: download PyOpenSSL_ and tell us if it works!
    1.53  
    1.54  4) Download ConfigObj_ and enter::
    1.55  
    1.56 @@ -126,7 +118,7 @@
    1.57  Debian Lenny (testing)
    1.58    You can install all dependencies by the command::
    1.59  
    1.60 -     aptitude install python-twisted-core python-gnutls \
    1.61 +     aptitude install python-twisted-core python-pyopenssl \
    1.62                        python-configobj python-gmpy
    1.63  
    1.64    The backslash indicates that both lines should be typed as a single
    1.65 @@ -196,24 +188,24 @@
    1.66  2) Open three separate command prompts and go to the ``viff/apps/``
    1.67     directory in each. In the first, type::
    1.68  
    1.69 -     python millionaires.py --no-tls player-3.ini
    1.70 +     python millionaires.py --no-ssl player-3.ini
    1.71  
    1.72     in the second, type::
    1.73  
    1.74 -     python millionaires.py --no-tls player-2.ini
    1.75 +     python millionaires.py --no-ssl player-2.ini
    1.76  
    1.77     and in the last, type::
    1.78  
    1.79 -     python millionaires.py --no-tls player-1.ini
    1.80 +     python millionaires.py --no-ssl player-1.ini
    1.81  
    1.82     Note that the order in wich you start the players is important: The
    1.83     players must start in reverse order, e.g. the last player first. If
    1.84     the installation works, you should see something like this from
    1.85     e.g. player 3::
    1.86  
    1.87 -      C:\viff\apps> python millionaires.py --no-tls player-3.ini 
    1.88 +      C:\viff\apps> python millionaires.py --no-ssl player-3.ini 
    1.89        Seeding random generator with random seed 7416
    1.90 -      Not using TLS
    1.91 +      Not using SSL
    1.92        I am Millionaire 3 and I am worth 20 millions.
    1.93        From poorest to richest:
    1.94          Millionaire 2
    1.95 @@ -239,11 +231,9 @@
    1.96  .. _Twisted: http://twistedmatrix.com/
    1.97  .. _ConfigObj: http://voidspace.org.uk/python/configobj.html
    1.98  .. _GMPY: http://code.google.com/p/gmpy/
    1.99 -.. _python-gnutls: http://pypi.python.org/pypi/python-gnutls/
   1.100 +.. _PyOpenSSL: http://pyopenssl.sourceforge.net/
   1.101  .. _MacPython: http://www.pythonmac.org
   1.102  .. _XCode: http://developer.apple.com/tools/xcode/
   1.103 -.. _gnutls: http://www.gnu.org/software/gnutls/manual/gnutls.html
   1.104 -            #Downloading-and-Installing
   1.105  .. _package manager: `Using a Package Manager`_
   1.106  .. _from source: `Installing from Source`_
   1.107  .. _file a bug report: http://tracker.viff.dk/