Changeset 14560

Timestamp:

19 Feb 2017, 10:52:16 (8 years ago)

Author:

Henrik Bettermann

Message:

Update README.txt.

File:

• main/kofacustom.sampleuni/trunk/README.txt (modified) (2 diffs)

main/kofacustom.sampleuni/trunk/README.txt

@@ -1 @@
-waeup.sampleuni
-***************
+WAeUP.Sampleuni
 
-`waeup.sampleuni` is a Python package providing a student information
-portal based on WAeUP Kofa.
+###############
 
-This is a skelton package which can be used to create customized version of Kofa.
+`waeup.sampleuni` is a Python package (in the following referred to as
+Sampleuni) providing a student information portal based on WAeUP.Kofa.
+Sampleuni is a skelton package which can be used to create a customized
+version of Kofa.
 
 For generic install instructions please see 
@@ -11 +12 @@
   http://kofa-doc.waeup.org/userdocs/install.html
 
-Repository
-==========
 
-The Subversion_ repository location of this package is
+Quick Install on Ubuntu 14.04 or 16.04
+**************************************
 
-  https://svn.waeup.org/repos/main/waeup.sampleuni/
+If you want to install Sampleuni on a running Ubuntu system, the following quick
+steps might be sufficient::
 
-.. _Subversion: http://subversion.apache.org/
+  ## install neccessary system packages as superuser
+  $ sudo apt-get update && apt-get install -y  # update system
+  $ 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
+  $ sudo ln -s /usr/include/freetype2 /usr/include/freetype2/freetype
+
+  ## unpack sources as regular user (probably already done if you
+  ## read this README)
+  $ tar xzf waeup.sampleuni
+  $ cd waeup.sampleuni
+
+  ## create python sandbox and build kofa
+  $ virtualenv py27
+  $ source py27/bin/activate
+  $ pip install --upgrade pip
+  $ python bootstrap.py
+  $ ./bin/buildout
+
+To run Sampleuni, now do::
+
+  ## startup Kofa in foreground (recommended for first start)
+  $ ./bin/kofactl fg
+  ## press CTRL-D to stop the kofa server
+
+  ## startup Kofa in background
+  $ ./bin/kofactl start
+  $ ./bin/kofactl status  # check status, running or not
+  $ ./bin/kofactl stop    # stop running instance (also 'restart' possible)
+
+When Sampleuni is running, you can access the portal on port 8080. Open
+
+  http://localhost:8080/
+
+and enter the credentials (username 'grok', password 'grok' by
+default) and name and add a `University`.
+
+Congratulations, you got Sampleuni running.