25
25
:file:`ivle.conf` file and configuring Apache to serve the IVLE webapp and
26
26
Subversion repositories.
28
.. _ref-configuration-options:
30
28
Configuration options
31
29
=====================
33
31
Most of the configuration of IVLE is done by editing the file
34
32
: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
33
settings are required as part of the `install process <ref-install>` and for
34
actual running of IVLE.
174
164
Location where Subversion WebDAV AuthUserFile password hash file will be
177
.. _ref-configuration-policy:
181
Site-specific policy decisions on permissions, etc. These modify the user
182
roles, as described in :ref:`ref-user-roles`.
184
.. describe:: tutors_can_enrol_students
186
:type: boolean(default=False)
188
If True, tutors can enrol any IVLE user as a student in a subject they are
189
tutoring. This is disabled by default, as it is generally considered
190
unnecessary for tutors to have such power.
192
.. describe:: tutors_can_edit_worksheets
194
:type: boolean(default=True)
196
If True, tutors can create and edit worksheets in a subject they are
197
tutoring, and can create and edit *any exercise in the system*. This is
198
turned on by default, but should be used carefully. Untrusted tutors could
199
create site-wide problems.
201
(The reason tutors can edit any exercise is because exercises are not
202
stored per-subject, so it isn't possible to limit them just to exercises
203
for a particular subject.)
207
Configuration of media serving.
169
Configuration of `media serving <ref-media-serving>`_.
209
171
.. describe:: version
272
Settings for configuring external user authentication with
273
:ref:`authentication modules <ref-auth-modules>` and automatic subject
274
enrollment with :ref:`subject pulldown modules
275
<ref-subject-pulldown-modules>`.
234
Settings for configuring external user authentication with `authentication
235
modules <ref-auth-modules>`_ and automatic subject enrollment with `subject
236
pulldown modules <ref-subject-pulldown-modules>`_.
277
238
.. describe:: modules
279
240
:type: string_list(default=list())
281
List of :ref:`authentication modules <ref-auth-modules>` to attempt to
242
List of `authentication modules <ref-auth-modules>`_ to attempt to
282
243
authenticate with if a user does not have a password set in the local
298
259
:type: string_list(default=list())
300
List of :ref:`subject pulldown modules <ref-subject-pulldown-modules>` to
301
be checked when a user signs into IVLE to see what subjects a student is
261
List of `subject pulldown modules <ref-subject-pulldown-modules>`_ to be
262
checked when a user signs into IVLE to see what subjects a student is
306
Settings for the :ref:`User Management Server <ref-usrmgt-server>`.
267
Settings for the `User Management Server <ref-usrmgt-server>`_.
308
269
.. describe:: host
360
321
:type: string_list(default=list())
362
323
A list of extra source locations to be added to the jail builder (such as
363
for site specific packages). For example, 'deb
364
http://ppa.launchpad.net/wgrant/ivle/ubuntu/ hardy main,'.
324
for site specific packages).
366
326
.. describe:: extra_packages
368
328
:type: string_list(default=list())
370
330
A list of extra packages to be installed in addition to the core packages
371
required for IVLE. For example, 'python-scipy, python-networkx,'
333
.. FIXME: Is this correct. Is it extra user packages (such as
334
python-scipy) or all packages that aren't in a standard debootstrap build
335
(such as python-svn and python-cjson)?.
373
337
.. describe:: extra_keys
377
341
Any extra package signing keys to accept as correctly validate installed
378
342
packages. Typically used for validating ``extra_sources`` packages.
380
Keys can be provided in tripple quoted blocks. For multiple keys, simply
381
concatinate the key blocks. For example::
383
extra_keys = '''-----BEGIN PGP PUBLIC KEY BLOCK-----
386
mI0ESXMxaQEEAMdundmJeTMUcB6fRXGQ3WJH+5hlfj3ehurF3u0ubr4sQpxfJvl6/KV4UcOC
387
RvK4aufNInJxKrT6xvzdMNE9z5NO/ZVZdkr2NfcRO/0Yxgmaft9qjxfV+3NEBrvJkqm8ApVO
388
hsxFW6VWyeHBELSiNxNGToPp+2g3i5VAlWbtzaapABEBAAG0H0xhdW5jaHBhZCBQUEEgZm9y
389
IFdpbGxpYW0gR3JhbnSIRgQQEQIABgUCSXOMJAAKCRABz5LwpyR9xeXXAJ97VdeI3lLDvyM9
390
TLeb48Ylj8dWdQCfcOJDRGfjRu9PI2+ekIoV8TqaC0GItgQTAQIAIAUCSXMxaQIbAwYLCQgH
391
AwIEFQIIAwQWAgMBAh4BAheAAAoJECp86x2KYmtCEBED/0aRhr7wKmA/nyX2rUN/1dpyYT2T
392
khxJT0F7l91/PGRkLUdvcX81ceRcYeiiR1x8N1tL7pwrTWZwaQ/HTHF19ZAXjptnn8zaLKUc
393
VwhOrUdFE2FzNo42BWpXQAuJuBCG3DeIXDDuPRvtL+sx7h8PD/DlE5RsTaztkkbWdpkMtJp9
395
-----END PGP PUBLIC KEY BLOCK-----
396
-----BEGIN PGP PUBLIC KEY BLOCK-----
397
Version: GnuPG v1.4.9 (GNU/Linux)
399
mQGiBEFEnz8RBAC7LstGsKD7McXZgd58oN68KquARLBl6rjA2vdhwl77KkPPOr3O
400
YeSBH/voUsqausJfDNuTNivOfwceDe50lbhq52ODj4Mx9Jg+4aHn9fmRkIk41i2J
401
3hZiIGPACY/FsSlRq1AhBH2wZG1lQ45W/p77AeARRehYKJP9HY+1h/uihwCgrVE2
402
VzACJLuZWHbDsPoJaNQjiFcEAKbUF1rMyjd1xJM7bZeXbs8c+ohUo/ywSI/OIr8n
404
RwIbDAAKCRBAl26vQ30FtdxYAJsFjU+xbex7gevyGQ2/mhqidES4MwCggqQyo+w1
407
-----END PGP PUBLIC KEY BLOCK-----
344
.. note:: Cannot have triple-quoted list members.
446
382
The IVLE web application runs on Apache using ``mod_python``. An example
447
configuration for normal HTTP is provided in the file
448
:file:`examples/config/apache.conf` and an example configuration for using
449
Secure HTTP using SSL certificates is provided in the file
450
:file:`examples/config/apache-ssl.conf`.
383
configuration is provided in the file :file:`examples/config/apache.conf`.
452
385
At minimum the following settings must be specified:
added
removed
doc/man/config.rst
