27
27
Configuration options
28
28
=====================
32
Configuration of URLs used by the IVLE webapp.
36
:type: string(default="/")
38
Path on HTTP server that IVLE is served from.
40
.. describe:: public_host
44
The server goes into "public mode" if the browser sends a request with
45
this host. This is for security reasons - we only serve public student
46
files on a separate domain to the main IVLE site.
47
Public mode does not use cookies, and serves only public content.
48
Private mode (normal mode) requires login, and only serves files relevant
49
to the logged-in user. e.g. 'public.ivle.org'
51
.. describe:: svn_addr
55
The base url for accessing subversion repositories. e.g.
60
Configuration for IVLE installation and data paths.
64
:type: string(default="/usr/local")
66
The prefix that is prepended to installation paths.
70
:type: string(default="/var/lib/ivle")
72
Directory where IVLE data such as user jails will be stored.
76
:type: string(default="/var/log/ivle")
78
Directory where IVLE log files such as :file:`ivle_error.log` will be
82
:type: string(default="${prefix}/share/ivle")
84
Directory where IVLE shared data such as ``usrmgt-server``,
85
``python-console`` and services will be installed.
89
:type: string(default="${prefix}/lib/ivle")
91
Directory where IVLE libraries such as ``trampoline`` and ``timount`` will
96
Configuration paths for user `Jails <ref-jail>`_.
100
:type: string(default="${data}/jailmounts"))
102
Directory where complete jails will be mounted.
107
:type: string(default="${data}/jails")
109
Directory where user specific jail content will be stored.
111
.. describe:: template
113
:type: string(default="${src}/__base__")
115
Directory where template file system for each jail will be stored.
117
.. describe:: template_build
119
:type: string(default="${src}/__base_build__")
121
Directory where template file system will be built before being moved to
122
the ``template`` directory.
126
Configuration paths for Subversion repositories.
130
:type: string(default="${data}/svn")
132
Directory where Subversion data will be stored
136
:type: string(default="${base}/svn.conf")
138
Location of Subversion WebDAV AuthzSVNAccessFile configuration file for
139
user repositories will be stored.
141
.. describe:: group_conf
143
:type: string(default="${base}/svn-group.conf")
145
Location of Subversion WebDAV AuthzSVNAccessFile configuration file for
146
group repositories will be stored.
148
.. describe:: repo_path
150
:type: string(default="${base}/repositories")
152
Location where user and group repositories will be stored.
154
.. describe:: auth_ivle
156
:type: string(default="${base}/ivle.auth")
158
Location where Subversion WebDAV AuthUserFile password hash file will be
163
Configuration of `media serving <ref-media-serving>`_.
165
.. describe:: version
167
:type: string(default=None)
169
Media files such as images, CSS and JavaScript are aggressively cached in
170
IVLE. If this value is set then IVLE will send media URLs containing this
171
version number and content will be served with an ``Expires`` header set a
172
year in the future. This means that the client should only request a media
173
URL once and use the cached copy from then on. This version number should
174
be incremented each time any media is changed (typically this should just
175
be set to the IVLE release number) so that updated media will be sent to
178
If not provided or set to :const:`None`, IVLE will use standard browser
183
Configuration details for external media dependencies used by IVLE.
187
:type: string(default="/usr/share/javascript/jquery")
189
Directory where jQuery library is installed.
194
Configuration for the PostgreSQL database that IVLE uses.
198
:type: string(default="localhost")
200
Hostname of database IVLE server.
204
:type: integer(default=5432)
206
Port the database runs on.
210
:type: string(default="ivle")
212
Name of the IVLE database on the database server.
214
.. describe:: username
218
Username which IVLE uses on the database server.
220
.. describe:: password
224
Password which IVLE uses for authentication with the database server.
228
Settings for configuring external user authentication with `authentication
229
modules <ref-auth-modules>`_ and automatic subject enrollment with `subject
230
pulldown modules <ref-subject-pulldown-modules>`_.
232
.. describe:: modules
234
:type: string_list(default=list())
236
List of `authentication modules <ref-auth-modules>`_ to attempt to
237
authenticate with if a user does not have a password set in the local
240
.. describe:: ldap_url
242
:type: string(default=None)
244
URL of the LDAP server to be used by authentication modules.
246
.. describe:: ldap_format_string
248
:type: string(default=None)
251
.. describe:: subject_pulldown_modules
253
:type: string_list(default=list())
255
List of `subject pulldown modules <ref-subject-pulldown-modules>`_ to be
256
checked when a user signs into IVLE to see what subjects a student is
261
Settings for the `User Management Server <ref-usrmgt-server>`_.
265
:type: string(default="localhost")
267
The hostname where the User Management Server is running.
271
:type: integer(default=2178)
273
The port that the User Management Server is running on.
279
The shared secret used to secure communication between IVLE Web
280
Application and the User Management Server.
284
Options that control how the `Jail <ref-jail>`_ is built.
286
.. describe:: devmode
288
:type: boolean(default=False)
290
If set, copies IVLE files from the local machine into the jail rather than
291
installing them from a package.
295
If the Python site packages directory differs between the local
296
machine and the jail (such as if different versions of Python are
297
installed) you will need to supply the site packages to be installed
298
with the ``--python-site-packages`` option to ``ivle-buildjail``.
302
:type: string(default="hardy")
304
Which suite the jail will build with. This need not be the same as what
305
the local machine is running.
309
:type: string(default="http://archive.ubuntu.com/ubuntu")
311
The location of a HTTP mirror containing the specified suite.
313
.. describe:: extra_sources
315
:type: string_list(default=list())
317
A list of extra source locations to be added to the jail builder (such as
318
for site specific packages).
320
.. describe:: extra_packages
322
:type: string_list(default=list())
324
A list of extra packages to be installed in addition to the core packages
327
.. FIXME: Is this correct. Is it extra user packages (such as
328
python-scipy) or all packages that aren't in a standard debootstrap build
329
(such as python-svn and python-cjson)?.
331
.. describe:: extra_keys
333
:type: string(default=None)
335
Any extra package signing keys to accept as correctly validate installed
336
packages. Typically used for validating ``extra_sources`` packages.
338
.. note:: Cannot have triple-quoted list members.
343
User specific settings that are added to a user's :file:`ivle.conf` file
348
This should be in a user-specific place but since we're worried a user
349
may delete his/her .conf file, we put it here for now). These properties
350
**should not** be set in the server's :file:`/etc/ivle/ivle.conf`.
354
:type: string(default=None)
356
The login name of the user.
358
.. describe:: svn_pass
360
:type: string(default=None)
362
The key used to access repositories on the Subversion server.
365
30
Apache configuration
366
31
====================
added
removed
doc/man/config.rst
