source: main/kofacustom.sampleuni/trunk/README.txt @ 15848

Last change on this file since 15848 was 14565, checked in by Henrik Bettermann, 8 years ago

Use the correct package name.

File size: 1.8 KB
RevLine 
[14565]1WAeUP Sampleuni
[14560]2###############
[10765]3
[14565]4`kofacustom.sampleuni` (further referred to as Sampleuni) is a Python package
[14562]5providing a student information portal based on WAeUP.Kofa. It is a skeleton
6package which can be used to create customized versions of Kofa.
[10765]7
[11688]8For generic install instructions please see
[11428]9
[11688]10  http://kofa-doc.waeup.org/userdocs/install.html
11
[11428]12
[14560]13Quick Install on Ubuntu 14.04 or 16.04
14**************************************
[11428]15
[14562]16If you want to install Sampleuni on a running Ubuntu system, the
17following quick steps might be sufficient::
[11428]18
[14560]19  ## install neccessary system packages as superuser
20  $ sudo apt-get update && apt-get install -y  # update system
21  $ sudo apt-get install python2.7-dev libxml2-dev libxslt1-dev zlib1g-dev python-virtualenv libssl-dev libffi-dev libjpeg-dev libfreetype6-dev libtiff-dev libopenjpeg-dev
22  $ sudo ln -s /usr/include/freetype2 /usr/include/freetype2/freetype
23
24  ## unpack sources as regular user (probably already done if you
25  ## read this README)
26  $ tar xzf waeup.sampleuni
27  $ cd waeup.sampleuni
28
29  ## create python sandbox and build kofa
30  $ virtualenv py27
31  $ source py27/bin/activate
32  $ pip install --upgrade pip
33  $ python bootstrap.py
34  $ ./bin/buildout
35
36To run Sampleuni, now do::
37
38  ## startup Kofa in foreground (recommended for first start)
39  $ ./bin/kofactl fg
40  ## press CTRL-D to stop the kofa server
41
42  ## startup Kofa in background
43  $ ./bin/kofactl start
44  $ ./bin/kofactl status  # check status, running or not
45  $ ./bin/kofactl stop    # stop running instance (also 'restart' possible)
46
47When Sampleuni is running, you can access the portal on port 8080. Open
48
49  http://localhost:8080/
50
51and enter the credentials (username 'grok', password 'grok' by
52default) and name and add a `University`.
53
54Congratulations, you got Sampleuni running.
Note: See TracBrowser for help on using the repository browser.