Changeset 11381


Ignore:
Timestamp:
23 Feb 2014, 11:32:38 (11 years ago)
Author:
uli
Message:

Update docs.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • main/waeup.aaua/trunk/INSTALL.txt

    r11376 r11381  
    1 Installation of Kofa on Linux production system
    2 ###############################################
    3 
    4 .. note:: `waeup.kofa` and its custom packages
    5           might not work with Python > 2.7
    6           currently. Use of Python 2.7 is recommended.
    7           The installation is described for Linux-based computers.
    8 
    9 Part 1: Deploying Kofa as a single Zope client install
    10 ******************************************************
     1Installation of Kofa
     2####################
     3
     4These are generic installation instructions for the WAeUP_ ``Kofa``
     5student information portal and customized versions thereof.
     6
     7For specific aspects of this package please refer to the local README
     8file.
     9
     10Please note, that **only Linux-based installs** are described and actively
     11supported. We recommend use of Debian_ / Ubuntu_.
     12
     13.. note:: This means we do not actively support Windows(tm)!
     14
    1115
    1216Prerequisites
    13 =============
    14 
    15 The Kofa packages are based on `Grok`_, which is a Python
    16 framework for agile webapplication development. Grok itself is based
     17*************
     18
     19The Kofa packages are based on `Grok`_, which is a Python_
     20framework for agile webapplication development. Grok_ itself is based
    1721on `Zope`_.
    1822
    19 .. _Grok: http://grok.zope.org/
    20 
    21 .. _Zope: http://www.zope.org/
    22 
    23 Both, Grok and Zope, are written in Python (with parts written in
    24 C). You therefore need `Python`_ installed.
    25 
    26 .. _Python: http://www.python.org/
    27 
    28 Note, that you also need the Python header files and a compiler to
    29 compile the parts written in C.
    30 
    31 To deploy Kofa most easily, we use `zc.buildout`_
    32 
    33 .. _zc.buildout: http://cheeseshop.python.org/pypi/zc.buildout
    34 
    35 
    36 Preparing the system
     23Both, Grok_ and Zope_, are written in the `Python`_ programming
     24language (with parts written in C). You therefore have to have
     25`Python`_ installed (including `Python`_ headers).
     26
     27
     28Preparing the System
    3729====================
    3830
    39 To create a working copy of Kofa we recommend use of
    40 `virtualenv`. You, however, need also some basic libraries, a C
    41 compiler and some things more.
     31For a `Kofa` install we need of course `Python`_ installed as well as
     32some standard developer tools like C compilers, C libraries, etc.
    4233
    4334What you need (Debian/Ubuntu package names in brackets):
    4435
    45 * Python 2.7 (python2.7)
    46 
    47 * Python 2.7 development files (python2.7-dev)
    48 
    49 * A C-Compiler (gcc)
    50 
    51 * The C library development files (libc6-dev)
    52 
    53 * A subversion client (svn)
    54 
    55 * enscript (enscript) [optional]
     36* Python 2.7 (``python2.7``)
     37
     38* Python 2.7 development files (``python2.7-dev``)
     39
     40* A C-Compiler with basic C developer libraries (``build-essential``)
     41
     42* A subversion client (``svn``)
     43
     44* enscript (``enscript``) [optional]
    5645
    5746  This is only needed if you want test coverage reports.
    … …  
    5948All these packages can be installed on Debian systems like this::
    6049
    61   # apt-get install python2.7 python2.7-dev python2.7-dbg \
    62                     gcc libc6-dev svn enscript
     50  $ sudo apt-get install python2.7 python2.7-dev svn \
     51                         build-essential enscript
    6352
    6453Afterwards you should be able to enter::
    … …  
    6655  $ python2.7
    6756
    68 at the commandline and get a Python prompt. Quit the interpreter
     57at the commandline and get a Python_ prompt. Quit the interpreter
    6958pressing <CTRL-D>.
    7059
    … …  
    7362=======================
    7463
    75 We recommend use of `virtualenv` to create Python sandboxes where you
     64We recommend use of `virtualenv`_ to create Python_ sandboxes where you
    7665can run your code without touching any other installations.
    7766
    … …  
    159148  (sandbox27)$ cd kofa-trunk
    160149
     150
     151You can run ``Kofa`` with a single client (useful for evaluation,
     152development, etc.) or with multiple clients running in parallel. The
     153latter setup is useful in productive environments with many thousands
     154users. We will cover both setup types one after another.
     155
     156
     157Part 1: Single Client Setup
     158***************************
    161159
    162160Preparing the build
    … …  
    394392regular non-ZEO kofactl might not make to much sense. Therefore all
    395393this might be subject to changes.
     394
     395.. _Debian: http://www.debian.org/
     396.. _Grok: http://grok.zope.org/
     397.. _Python: http://www.python.org/
     398.. _Ubuntu: http://www.ubuntu.com/
     399.. _virtualenv: http://www.virtualenv.org/en/latest/
     400.. _WAeUP: https://www.waeup.org/
     401.. _Zope: http://www.zope.org/
     402.. _zc.buildout: http://cheeseshop.python.org/pypi/zc.buildout
Note: See TracChangeset for help on using the changeset viewer.