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
18
.. _ref-configuring-ivle:
24
This page describes the configuration of IVLE. This consists of populating the
25
:file:`ivle.conf` file and configuring Apache to serve the IVLE webapp and
26
Subversion repositories.
28
.. _ref-configuration-options:
33
Most of the configuration of IVLE is done by editing the file
34
:file:`ivle.conf`, located by default in :file:`/etc/ivle/ivle.conf`. These
35
settings are required as part of the :ref:`install process <ref-install>`,
36
though the :ref:`admin script <ref-admin-scripts>` :program:`ivle-config` can
37
be used to propagate most of these settings.
39
It uses the `ConfigObj`_ text format which is heavily based on the 'INI' text
40
format. Of particular note, lists with single items need to be terminated
41
with a ',' otherwise it will be treated as a list of characters (usually not
44
.. _ConfigObj: http://www.voidspace.org.uk/python/configobj.html
48
Configuration of URLs used by the IVLE webapp.
52
:type: string(default="/")
54
Path on HTTP server that IVLE is served from.
56
.. describe:: public_host
60
The server goes into "public mode" if the browser sends a request with
61
this host. This is for security reasons - we only serve public student
62
files on a separate domain to the main IVLE site.
63
Public mode does not use cookies, and serves only public content.
64
Private mode (normal mode) requires login, and only serves files relevant
65
to the logged-in user. e.g. 'public.ivle.org'
67
.. describe:: svn_addr
71
The base url for accessing subversion repositories. e.g.
76
Configuration for IVLE installation and data paths.
80
:type: string(default="/usr/local")
82
The prefix that is prepended to installation paths.
86
:type: string(default="/var/lib/ivle")
88
Directory where IVLE data such as user jails will be stored.
92
:type: string(default="/var/log/ivle")
94
Directory where IVLE log files such as :file:`ivle_error.log` will be
98
:type: string(default="${prefix}/share/ivle")
100
Directory where IVLE shared data such as ``usrmgt-server``,
101
``python-console`` and services will be installed.
105
:type: string(default="${prefix}/lib/ivle")
107
Directory where IVLE libraries such as ``trampoline`` and ``timount`` will
112
Configuration paths for user `Jails <ref-jail>`_.
116
:type: string(default="${data}/jailmounts"))
118
Directory where complete jails will be mounted.
123
:type: string(default="${data}/jails")
125
Directory where user specific jail content will be stored.
127
.. describe:: template
129
:type: string(default="${src}/__base__")
131
Directory where template file system for each jail will be stored.
133
.. describe:: template_build
135
:type: string(default="${src}/__base_build__")
137
Directory where template file system will be built before being moved to
138
the ``template`` directory.
142
Configuration paths for Subversion repositories.
146
:type: string(default="${data}/svn")
148
Directory where Subversion data will be stored
152
:type: string(default="${base}/svn.conf")
154
Location of Subversion WebDAV AuthzSVNAccessFile configuration file for
155
user repositories will be stored.
157
.. describe:: group_conf
159
:type: string(default="${base}/svn-group.conf")
161
Location of Subversion WebDAV AuthzSVNAccessFile configuration file for
162
group repositories will be stored.
164
.. describe:: repo_path
166
:type: string(default="${base}/repositories")
168
Location where user and group repositories will be stored.
170
.. describe:: auth_ivle
172
:type: string(default="${base}/ivle.auth")
174
Location where Subversion WebDAV AuthUserFile password hash file will be
179
Configuration of `media serving <ref-media-serving>`_.
181
.. describe:: version
183
:type: string(default=None)
185
Media files such as images, CSS and JavaScript are aggressively cached in
186
IVLE. If this value is set then IVLE will send media URLs containing this
187
version number and content will be served with an ``Expires`` header set a
188
year in the future. This means that the client should only request a media
189
URL once and use the cached copy from then on. This version number should
190
be incremented each time any media is changed (typically this should just
191
be set to the IVLE release number) so that updated media will be sent to
194
If not provided or set to :const:`None`, IVLE will use standard browser
199
Configuration details for external media dependencies used by IVLE.
203
:type: string(default="/usr/share/javascript/jquery")
205
Directory where jQuery library is installed.
210
Configuration for the PostgreSQL database that IVLE uses.
214
:type: string(default="localhost")
216
Hostname of database IVLE server.
220
:type: integer(default=5432)
222
Port the database runs on.
226
:type: string(default="ivle")
228
Name of the IVLE database on the database server.
230
.. describe:: username
234
Username which IVLE uses on the database server.
236
.. describe:: password
240
Password which IVLE uses for authentication with the database server.
244
Settings for configuring external user authentication with `authentication
245
modules <ref-auth-modules>`_ and automatic subject enrollment with `subject
246
pulldown modules <ref-subject-pulldown-modules>`_.
248
.. describe:: modules
250
:type: string_list(default=list())
252
List of `authentication modules <ref-auth-modules>`_ to attempt to
253
authenticate with if a user does not have a password set in the local
256
.. describe:: ldap_url
258
:type: string(default=None)
260
URL of the LDAP server to be used by authentication modules.
262
.. describe:: ldap_format_string
264
:type: string(default=None)
267
.. describe:: subject_pulldown_modules
269
:type: string_list(default=list())
271
List of `subject pulldown modules <ref-subject-pulldown-modules>`_ to be
272
checked when a user signs into IVLE to see what subjects a student is
277
Settings for the `User Management Server <ref-usrmgt-server>`_.
281
:type: string(default="localhost")
283
The hostname where the User Management Server is running.
287
:type: integer(default=2178)
289
The port that the User Management Server is running on.
295
The shared secret used to secure communication between IVLE Web
296
Application and the User Management Server.
300
Options that control how the `Jail <ref-jail>`_ is built.
302
.. describe:: devmode
304
:type: boolean(default=False)
306
If set, copies IVLE files from the local machine into the jail rather than
307
installing them from a package.
311
If the Python site packages directory differs between the local
312
machine and the jail (such as if different versions of Python are
313
installed) you will need to supply the site packages to be installed
314
with the ``--python-site-packages`` option to ``ivle-buildjail``.
318
:type: string(default="hardy")
320
Which suite the jail will build with. This need not be the same as what
321
the local machine is running.
325
:type: string(default="http://archive.ubuntu.com/ubuntu")
327
The location of a HTTP mirror containing the specified suite.
329
.. describe:: extra_sources
331
:type: string_list(default=list())
333
A list of extra source locations to be added to the jail builder (such as
334
for site specific packages). For example, 'deb
335
http://ppa.launchpad.net/wgrant/ivle/ubuntu/ hardy main,'.
337
.. describe:: extra_packages
339
:type: string_list(default=list())
341
A list of extra packages to be installed in addition to the core packages
342
required for IVLE. For example, 'python-scipy, python-networkx,'
344
.. describe:: extra_keys
346
:type: string(default=None)
348
Any extra package signing keys to accept as correctly validate installed
349
packages. Typically used for validating ``extra_sources`` packages.
351
Keys can be provided in tripple quoted blocks. For multiple keys, simply
352
concatinate the key blocks. For example::
354
extra_keys = '''-----BEGIN PGP PUBLIC KEY BLOCK-----
357
mI0ESXMxaQEEAMdundmJeTMUcB6fRXGQ3WJH+5hlfj3ehurF3u0ubr4sQpxfJvl6/KV4UcOC
358
RvK4aufNInJxKrT6xvzdMNE9z5NO/ZVZdkr2NfcRO/0Yxgmaft9qjxfV+3NEBrvJkqm8ApVO
359
hsxFW6VWyeHBELSiNxNGToPp+2g3i5VAlWbtzaapABEBAAG0H0xhdW5jaHBhZCBQUEEgZm9y
360
IFdpbGxpYW0gR3JhbnSIRgQQEQIABgUCSXOMJAAKCRABz5LwpyR9xeXXAJ97VdeI3lLDvyM9
361
TLeb48Ylj8dWdQCfcOJDRGfjRu9PI2+ekIoV8TqaC0GItgQTAQIAIAUCSXMxaQIbAwYLCQgH
362
AwIEFQIIAwQWAgMBAh4BAheAAAoJECp86x2KYmtCEBED/0aRhr7wKmA/nyX2rUN/1dpyYT2T
363
khxJT0F7l91/PGRkLUdvcX81ceRcYeiiR1x8N1tL7pwrTWZwaQ/HTHF19ZAXjptnn8zaLKUc
364
VwhOrUdFE2FzNo42BWpXQAuJuBCG3DeIXDDuPRvtL+sx7h8PD/DlE5RsTaztkkbWdpkMtJp9
366
-----END PGP PUBLIC KEY BLOCK-----
367
-----BEGIN PGP PUBLIC KEY BLOCK-----
368
Version: GnuPG v1.4.9 (GNU/Linux)
370
mQGiBEFEnz8RBAC7LstGsKD7McXZgd58oN68KquARLBl6rjA2vdhwl77KkPPOr3O
371
YeSBH/voUsqausJfDNuTNivOfwceDe50lbhq52ODj4Mx9Jg+4aHn9fmRkIk41i2J
372
3hZiIGPACY/FsSlRq1AhBH2wZG1lQ45W/p77AeARRehYKJP9HY+1h/uihwCgrVE2
373
VzACJLuZWHbDsPoJaNQjiFcEAKbUF1rMyjd1xJM7bZeXbs8c+ohUo/ywSI/OIr8n
375
RwIbDAAKCRBAl26vQ30FtdxYAJsFjU+xbex7gevyGQ2/mhqidES4MwCggqQyo+w1
378
-----END PGP PUBLIC KEY BLOCK-----
384
User specific settings that are added to a user's :file:`ivle.conf` file
389
This should be in a user-specific place but since we're worried a user
390
may delete his/her .conf file, we put it here for now). These properties
391
**should not** be set in the server's :file:`/etc/ivle/ivle.conf`.
395
:type: string(default=None)
397
The login name of the user.
399
.. describe:: svn_pass
401
:type: string(default=None)
403
The key used to access repositories on the Subversion server.
408
Apache is used in IVLE for hosting of the IVLE web application and hosting
409
Subversion repositories over WebDAV. Typically the Subversion repository will
410
run on the Master server and the Web Application will be run on a collection
411
of slaves. It is also possible to combine the two function together to run as
417
The IVLE web application runs on Apache using ``mod_python``. An example
418
configuration is provided in the file :file:`examples/config/apache.conf`.
420
At minimum the following settings must be specified:
422
.. describe:: ServerName
424
Should be the formal hostname of the server, typically one that users will
425
use to access IVLE. For example, 'ivle.org'.
427
.. describe:: ServerAlias
429
Should be set to the value of ``[urls] public_host`` that is specified in
430
:file:`ivle.conf`. This is to ensure that Apache will correctly handle
431
requests for the public content.
433
.. describe:: SetHandler
435
Must be ``mod_python``
437
.. describe:: PythonHandler
439
Must be ``ivle.dispatch``
441
.. describe:: PythonOption mod_python.file_session.database_directory
443
Session directory for mod_python. This must be a shared directory between
444
all Slave servers, in particular when operating through a load balancer.
445
If not provided then users will encounter inconsistent behavior such as
446
being thrown back to the login screen after logging in.
448
Optional settings are:
450
.. describe:: PythonOption mod_python.session.cookie_name
452
The name to be set for cookies rather than the one automatically generated
453
by mod_python. For example, 'ivle'.
455
.. describe:: PythonDebug
457
If this option is set, any uncaught errors from mod_python will be sent to
458
the browser rather than being sent to the error log. It is recommended
459
that this setting is only used for development or debugging.
461
Subversion Repository
462
---------------------
463
IVLE also uses Apache to provide HTTP access to user's Subversion repositories
464
using ``mod_dav_svn``. Typically this is run on a single, stand alone server;
465
though it may be run in conjunction with the Web Application. An example
466
configuration is provided in the file :file:`examples/config/apache-svn.conf`.
467
IVLE will automatically generate password hash and repository permission files
468
that are used to control access to the repositories.
470
IVLE expects to find the paths ``users/`` and ``groups/`` at the URL provided
471
by the value of ``[urls] svn_addr`` set in :file:`ivle.conf`. Thus there
472
should be two ``Location`` clauses configured, one for users and one for
482
.. describe:: SVNParentPath
484
Directory where user repositories are stored. Should be the value of
485
``[path] [[svn]] repo_path`` in :file:`ivle.conf` with 'users' appended.
486
For example, '/var/lib/ivle/svn/repositories/users'.
488
.. describe:: AuthzSVNAccessFile
490
Location of the configuration file used to assign permissions to user
491
repositories. Should be the same value as ``[path] [[svn]] conf`` in
494
.. describe:: Require
496
Must be ``valid-user``
498
.. describe:: AuthType
502
.. describe:: AuthName
504
The name that should appear on authentication requests. For example, 'IVLE
505
Subversion repository'.
507
.. describe:: AuthUserFile
509
Location of the password hash file for Subversion users. Should be the
510
same as the value of ``[path] [[svn]] auth_ivle``. For example,
511
'/var/lib/ivle/svn/ivle.auth'.
520
.. describe:: SVNParentPath
522
Directory where user repositories are stored. Should be the value of
523
``[path] [[svn]] repo_path`` in :file:`ivle.conf` with 'groups' appended.
524
For example, '/var/lib/ivle/svn/repositories/groups'.
526
.. describe:: AuthzSVNAccessFile
528
Location of the configuration file used to assign permissions to group
529
repositories. Should be the same value as ``[path] [[svn]] group_conf`` in
532
.. describe:: Require
534
Must be ``valid-user``
536
.. describe:: AuthType
540
.. describe:: AuthName
542
The name that should appear on authentication requests. For example, 'IVLE
543
Subversion repository'.
545
.. describe:: AuthUserFile
547
Location of the password hash file for Subversion users. Should be the
548
same as the value of ``[path] [[svn]] auth_ivle``. For example,
549
'/var/lib/ivle/svn/ivle.auth'.
added
removed
doc/man/config.rst
