Changeset 13829 for main/waeup.kofa/trunk/docs

Timestamp:

11 Apr 2016, 10:39:08 (9 years ago)

Author:

uli

Message:

Add quick install guide.

File:

• main/waeup.kofa/trunk/docs/INSTALL.txt (modified) (2 diffs)

main/waeup.kofa/trunk/docs/INSTALL.txt

@@ -17 +17 @@
 
 .. _prerequisites:
+
+
+Quick Install on Ubuntu 14.04
+*****************************
+
+If you want to install Kofa on a running Ubuntu 14.04 system, the
+following quick steps might be sufficient::
+
+  ## 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
+
+  ## get sources as regular user
+  $ wget https://pypi.python.org/packages/source/w/waeup.kofa/waeup.kofa-1.4.1.tar.gz && tar -xzf waeup.kofa-1.4.1.tar.gz
+  $ cd waeup.kofa-1.4.1
+
+  ## create python sandbox and build kofa
+  $ virtualenv py27
+  $ source py27/bin/activate
+  $ pip install --upgrade pip
+  $ python bootstrap.py
+  $ ./bin/buildout
+
+To run Kofa, 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 Kofa 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 Kofa running.
+
 
 Prerequisites
@@ -27 +71 @@
 Both, Grok_ and Zope_, are written in the `Python`_ programming
 language (with parts written in C). You therefore have to have
-`Python`_ installed (including `Python`_ headers).
+`Python`_ installed (including `Python`_ headers) in version 2.7
+(Python 3.x is currently not supported).