source: main/waeup.kwarapoly/trunk/docs/INSTALL.txt @ 11133

Last change on this file since 11133 was 7823, checked in by Henrik Bettermann, 13 years ago

Update docs.

File size: 2.4 KB
Line 
1Installation on Linux production system
2***************************************
3
4.. note:: `waeup.kofa` might not work with Python > 2.6
5          currently. Use of Python 2.6 is recommended.
6
7Prerequisites
8=============
9
10The `waeup.kofa` package is based on `Grok`_, which is a Python
11framework for agile webapplication development. Grok itself is based
12on `Zope`_.
13
14.. _Grok: http://grok.zope.org/
15
16.. _Zope: http://www.zope.org/
17
18Both, Grok and Zope, are written in Python (with parts written in
19C). You therefore need `Python`_ installed.
20
21.. _Python: http://www.python.org/
22
23Note, that you also need the Python header files and a compiler to
24compile the parts written in C.
25
26To deploy `waeup.kofa` most easily, we use `zc.buildout`_
27
28.. _zc.buildout: http://cheeseshop.python.org/pypi/zc.buildout
29
30You may have setuptools already installed for your system Python. In
31that case, you may need to upgrade it first because buildout requires
32a very recent version::
33
34    $ sudo easy_install -U setuptools
35
36If this command fails because easy_install is not available, there is
37a good chance you do not have setuptools available for your system
38Python. If so, there is no problem because setuptools will be
39installed locally by buildout.
40
41Bootstrap the buildout environment::
42
43    $ python2.6 bootstrap/bootstrap.py
44
45and run the buildout command::
46
47    $ bin/buildout
48    [lots of stuff will be downloaded and installed here]
49
50Note that if you have more than one sandbox for a Zope-based web
51application, it will probably make sense to share the eggs between the
52different sandboxes.  You can tell ``zc.buildout`` to use a central
53eggs directory by creating ``~/.buildout/default.cfg`` with the
54following contents::
55
56    [buildout]
57    eggs-directory = /home/bruno/buildout-eggs
58
59Running the `waeup.kofa` application
60======================================
61
62You can start Zope with the with the following command::
63
64    $ bin/kofactl fg
65   
66Alternatively you can do:
67
68    $ bin/paster serve parts/etc/deploy.ini   
69
70If you now connect to port 8080 and log in with username 'grok',
71password 'grok', you should be able to add the grok-based applications
72(such as ``University``) from the menu.
73
74Add an instance of ``University`` and click on the link next to the
75then visible entry in the list of installed applications.
76
77Running the tests
78=================
79
80The tests are easily run by executing the test runner that's
81installed in the ``bin`` directory::
82
83    $ bin/test
84
Note: See TracBrowser for help on using the repository browser.