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

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

Update README.txt.

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