1
.. IVLE - Informatics Virtual Learning Environment
2
Copyright (C) 2007-2009 The University of Melbourne
4
.. This program is free software; you can redistribute it and/or modify
5
it under the terms of the GNU General Public License as published by
6
the Free Software Foundation; either version 2 of the License, or
7
(at your option) any later version.
9
.. This program is distributed in the hope that it will be useful,
10
but WITHOUT ANY WARRANTY; without even the implied warranty of
11
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
GNU General Public License for more details.
14
.. You should have received a copy of the GNU General Public License
15
along with this program; if not, write to the Free Software
16
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25
Given versions are those on which IVLE is known to work; earlier versions
26
might work too. Debian/Ubuntu package names are given after the name of the
29
* Ubuntu 8.04 or later (other distros should work with some tweaking, but are untested)
30
* Apache 2.x with modules:
31
+ mod_python (``libapache2-mod-python``)
32
+ mod_dav_svn and mod_authz_svn (``libapache2-svn``)
33
* Python 2.5 or 2.6 with modules:
34
+ cjson (``python-cjson``)
35
+ ConfigObj (``python-configobj``)
36
+ docutils (``python-docutils``)
37
+ epydoc (``python-epydoc``)
38
+ FormEncode (``python-formencode``)
39
+ Genshi (``python-genshi``)
40
+ psycopg2 (``python-psycopg2``)
41
+ pysvn (``python-svn``)
42
+ Routes (``python-routes``)
43
+ Storm (``python-storm``)
44
* jQuery (``libjs-jquery``)
45
* PostgreSQL 8.3 or later (``postgresql``)
46
* Subversion (``subversion``)
47
* debootstrap (``debootstrap``)
49
* GCC and related build machinery (``build-essential``)
51
Master versus slave servers
52
===========================
54
Installing from a Debian package
55
================================
57
Installing from source
58
======================
60
While installing from a distribution package is often a better idea for
61
users, developers will need to install from a plain source tree.
63
To get the tree, either grab and extract a release tarball, or get the
64
very latest code using bzr: ::
68
You should then change into the new source directory.
70
As IVLE needs to compile some binaries, you must first build, then
74
sudo ./setup.py install
76
Unlike the package, you will have to manually set up the database and
79
.. TODO: Separate IVLE PostgreSQL account.
81
First you must create a PostgreSQL database, and populate it with the
82
IVLE schema. You may use any name for the database. ::
84
sudo -u postgres createdb ivle
85
sudo -u postgres createlang plpgsql ivle
86
sudo -u postgres psql -d ivle < userdb/users.sql
88
The configuration wizard - ``ivle-config`` - will ask you a series of
89
questions. Apart from database settings, the defaults should be correct
90
for a development system. If deploying IVLE properly - particularly on
91
multiple nodes - several options will need to be changed. Watching
100
.. Note: Place here only the configuration required to get the system
101
installed and running. Any further configuration should go in config.rst.
103
IVLE needs a directory hierarchy in which to store filesystem data, which
104
by default lives in ``/var/lib/ivle``. Create it now. ::
106
sudo ivle-createdatadirs
109
Configuring the jail environment
110
--------------------------------
112
You will require a self-contained jail environment in which to safely
113
execute student code.
114
Before you can actually build the jail, a few configuration options are
115
needed. Open up ``/etc/ivle/ivle.conf``, and find the ``[jail]`` section.
119
suite = jaunty # Replace this with the codename of your Ubuntu release.
120
mirror = http://url.to.archive/mirror # Replace with a fast Ubuntu mirror.
121
extra_packages = python-configobj, python-svn, python-cjson
123
.. TODO: Move this around a bit, as the config options required differ for
124
the packaged version.
126
Now we can actually build the jail. The creation process basically downloads
127
a minimal Ubuntu system and installs it in ``/var/lib/ivle/jails/__base__``.
128
Note that this could download a couple of hundred megabytes. ::
130
sudo ivle-buildjail -r
135
IVLE makes use of two Apache virtual hosts: one for the application itself,
136
and one for the Subversion services. There are example configuration files
137
in ``examples/config/apache.conf`` and ``examples/config/apache-svn.conf``,
138
which will run IVLE at ``http://ivle.localhost/``.
140
On a Debian or Ubuntu system, just copy those two files into
141
``/etc/apache2/sites-available`` under appropriate names (eg. ``ivle`` and
142
``ivle-svn``). Then you need to activate them: ::
145
sudo a2ensite ivle-svn
146
sudo /etc/init.d/apache2 reload
149
Configuring hostname resolution
150
--------------------------------
152
All of IVLE's hostnames need to be resolvable from the local system. For a
153
production environment, this would be done in DNS. For a development system,
154
this is usually done in ``/etc/hosts``. Add this line to that file: ::
156
127.0.1.1 ivle.localhost public.ivle.localhost svn.ivle.localhost
158
Code running inside the jail environment also needs to be able to resolve
159
those names. Add, to ``/var/lib/ivle/jails/__base_build__/etc/hosts``: ::
161
127.0.1.1 svn.ivle.localhost
163
Then refresh the active copy of the jail: ::
168
Configuring the user management server
169
--------------------------------------
171
You need to have the IVLE user management server (``usrmgt-server``) running
172
for many parts of IVLE to operate properly, so it should be configured to
173
start on boot. There is an example init script in
174
``examples/config/usrmgt-server.init``. For Debian or Ubuntu, copy it to
175
``/etc/init.d/ivle``. Start it now, and set it to start automatically: ::
177
sudo /etc/init.d/usrmgt-server start
178
sudo update-rc.d usrmgt-server defaults 99
181
Creating the initial user
182
-------------------------
184
The final step in getting a usable IVLE set up is creating a user. You'll
185
probably want admin privileges - if not, drop the ``--admin``. ::
187
sudo ivle-makeuser --admin -p password username 'Full Name'
189
You should then be able to browse to ``http://ivle.localhost/``, and
190
log in with that username and password.
193
For more advanced configuration, see :ref:`Configuring IVLE
194
<ref-configuring-ivle>`.
added
removed
doc/man/install.rst
