← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to doc/man/config.rst

  • Committer: William Grant
  • Date: 2009-12-07 11:01:50 UTC
  • mfrom: (1341.1.3 trunk)
  • Revision ID: grantw@unimelb.edu.au-20091207110150-jct30a9yru432ddn
Fix up the project set creation UI a bit.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/config.rst
 
1
.. IVLE - Informatics Virtual Learning Environment
 
2
   Copyright (C) 2007-2009 The University of Melbourne
 
3
 
 
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.
 
8
 
 
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.
 
13
 
 
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
 
17
 
 
18
.. _ref-configuring-ivle:
 
19
 
 
20
****************
 
21
Configuring IVLE
 
22
****************
 
23
 
 
24
This page describes the configuration of IVLE, which is done by editing the
 
25
file :file:`ivle.conf`, located by default in :file:`/etc/ivle/ivle.conf`.
 
26
 
 
27
Configuration options
 
28
=====================
 
29
 
 
30
[urls]
 
31
------
 
32
Configuration of URLs used by the IVLE webapp.
 
33
 
 
34
.. describe:: root
 
35
 
 
36
    :type: string(default="/")
 
37
 
 
38
    Path on HTTP server that IVLE is served from.
 
39
 
 
40
.. describe:: public_host
 
41
 
 
42
    :type: string
 
43
 
 
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'
 
50
 
 
51
.. describe:: svn_addr
 
52
 
 
53
    :type: string
 
54
 
 
55
    The base url for accessing subversion repositories. e.g.  
 
56
    'http://svn.ivle.org'
 
57
 
 
58
[paths]
 
59
-------
 
60
Configuration for IVLE installation and data paths.
 
61
 
 
62
.. describe:: prefix
 
63
 
 
64
    :type: string(default="/usr/local")
 
65
 
 
66
    The prefix that is prepended to installation paths.
 
67
 
 
68
.. describe:: data
 
69
 
 
70
    :type: string(default="/var/lib/ivle")
 
71
 
 
72
    Directory where IVLE data such as user jails will be stored.
 
73
 
 
74
.. describe:: logs
 
75
 
 
76
    :type: string(default="/var/log/ivle")
 
77
 
 
78
    Directory where IVLE log files such as :file:`ivle_error.log` will be 
 
79
    saved.
 
80
.. describe:: share
 
81
 
 
82
    :type: string(default="${prefix}/share/ivle")
 
83
 
 
84
    Directory where IVLE shared data such as ``usrmgt-server``, 
 
85
    ``python-console`` and services will be installed.
 
86
 
 
87
.. describe:: lib
 
88
 
 
89
    :type: string(default="${prefix}/lib/ivle")
 
90
 
 
91
    Directory where IVLE libraries such as ``trampoline`` and ``timount`` will 
 
92
    be installed.
 
93
 
 
94
[[jails]]
 
95
~~~~~~~~~
 
96
Configuration paths for user `Jails <ref-jail>`_.
 
97
 
 
98
.. describe:: mounts
 
99
 
 
100
    :type: string(default="${data}/jailmounts"))
 
101
 
 
102
    Directory where complete jails will be mounted.
 
103
 
 
104
 
 
105
.. describe:: src
 
106
 
 
107
    :type: string(default="${data}/jails")
 
108
 
 
109
    Directory where user specific jail content will be stored.
 
110
 
 
111
.. describe:: template
 
112
 
 
113
    :type: string(default="${src}/__base__")
 
114
 
 
115
    Directory where template file system for each jail will be stored.
 
116
 
 
117
.. describe:: template_build
 
118
 
 
119
    :type: string(default="${src}/__base_build__")
 
120
 
 
121
    Directory where template file system will be built before being moved to 
 
122
    the ``template`` directory.
 
123
 
 
124
[[svn]]
 
125
~~~~~~~
 
126
Configuration paths for Subversion repositories.
 
127
 
 
128
.. describe:: base
 
129
 
 
130
    :type: string(default="${data}/svn")
 
131
 
 
132
    Directory where Subversion data will be stored
 
133
 
 
134
.. describe:: conf
 
135
 
 
136
    :type: string(default="${base}/svn.conf")
 
137
 
 
138
    Location of Subversion WebDAV AuthzSVNAccessFile configuration file for 
 
139
    user repositories will be stored.
 
140
 
 
141
.. describe:: group_conf
 
142
 
 
143
    :type: string(default="${base}/svn-group.conf")
 
144
 
 
145
    Location of Subversion WebDAV AuthzSVNAccessFile configuration file for 
 
146
    group repositories will be stored.
 
147
 
 
148
.. describe:: repo_path
 
149
 
 
150
    :type: string(default="${base}/repositories")
 
151
 
 
152
    Location where user and group repositories will be stored.
 
153
 
 
154
.. describe:: auth_ivle
 
155
 
 
156
    :type: string(default="${base}/ivle.auth")
 
157
 
 
158
    Location where Subversion WebDAV AuthUserFile password hash file will be 
 
159
    stored.
 
160
 
 
161
[media]
 
162
-------
 
163
Configuration of `media serving <ref-media-serving>`_.
 
164
 
 
165
.. describe:: version
 
166
 
 
167
    :type: string(default=None)
 
168
 
 
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 
 
176
    clients.
 
177
 
 
178
    If not provided or set to :const:`None`, IVLE will use standard browser 
 
179
    caching.
 
180
 
 
181
[[externals]]
 
182
~~~~~~~~~~~~~
 
183
Configuration details for external media dependencies used by IVLE.
 
184
 
 
185
.. describe:: jquery
 
186
 
 
187
    :type: string(default="/usr/share/javascript/jquery")
 
188
 
 
189
    Directory where jQuery library is installed.
 
190
 
 
191
 
 
192
[database]
 
193
----------
 
194
Configuration for the PostgreSQL database that IVLE uses.
 
195
 
 
196
.. describe:: host
 
197
 
 
198
    :type: string(default="localhost")
 
199
 
 
200
    Hostname of database IVLE server.
 
201
 
 
202
.. describe:: port
 
203
 
 
204
    :type: integer(default=5432)
 
205
 
 
206
    Port the database runs on.
 
207
 
 
208
.. describe:: name
 
209
 
 
210
    :type: string(default="ivle")
 
211
 
 
212
    Name of the IVLE database on the database server.
 
213
 
 
214
.. describe:: username
 
215
 
 
216
    :type: string
 
217
 
 
218
    Username which IVLE uses on the database server.
 
219
 
 
220
.. describe:: password
 
221
 
 
222
    :type: string
 
223
 
 
224
    Password which IVLE uses for authentication with the database server.
 
225
 
 
226
[auth]
 
227
------
 
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>`_.
 
231
 
 
232
.. describe:: modules
 
233
 
 
234
    :type: string_list(default=list())
 
235
 
 
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 
 
238
    database.
 
239
 
 
240
.. describe:: ldap_url
 
241
 
 
242
    :type: string(default=None)
 
243
 
 
244
    URL of the LDAP server to be used by authentication modules.
 
245
 
 
246
.. describe:: ldap_format_string
 
247
 
 
248
    :type: string(default=None)
 
249
 
 
250
 
 
251
.. describe:: subject_pulldown_modules
 
252
 
 
253
    :type: string_list(default=list())
 
254
 
 
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 
 
257
    enrolled in.
 
258
 
 
259
[usrmgt]
 
260
--------
 
261
Settings for the `User Management Server <ref-usrmgt-server>`_.
 
262
 
 
263
.. describe:: host
 
264
 
 
265
    :type: string(default="localhost")
 
266
 
 
267
    The hostname where the User Management Server is running.
 
268
 
 
269
.. describe:: port
 
270
 
 
271
    :type: integer(default=2178)
 
272
 
 
273
    The port that the User Management Server is running on.
 
274
 
 
275
.. describe:: magic
 
276
 
 
277
    :type: string
 
278
 
 
279
    The shared secret used to secure communication between IVLE Web 
 
280
    Application and the User Management Server.
 
281
 
 
282
[jail]
 
283
------
 
284
Options that control how the `Jail <ref-jail>`_ is built.
 
285
 
 
286
.. describe:: devmode
 
287
 
 
288
    :type: boolean(default=False)
 
289
 
 
290
    If set, copies IVLE files from the local machine into the jail rather than  
 
291
    installing them from a package.
 
292
 
 
293
    .. note::
 
294
 
 
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``.
 
299
 
 
300
.. describe:: suite
 
301
 
 
302
    :type: string(default="hardy")
 
303
 
 
304
    Which suite the jail will build with. This need not be the same as what 
 
305
    the local machine is running.
 
306
 
 
307
.. describe:: mirror
 
308
 
 
309
    :type: string(default="http://archive.ubuntu.com/ubuntu")
 
310
 
 
311
    The location of a HTTP mirror containing the specified suite.
 
312
 
 
313
.. describe:: extra_sources
 
314
 
 
315
    :type: string_list(default=list())
 
316
 
 
317
    A list of extra source locations to be added to the jail builder (such as 
 
318
    for site specific packages).
 
319
 
 
320
.. describe:: extra_packages
 
321
 
 
322
    :type: string_list(default=list())
 
323
 
 
324
    A list of extra packages to be installed in addition to the core packages 
 
325
    required for IVLE.
 
326
 
 
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)?.
 
330
 
 
331
.. describe:: extra_keys
 
332
 
 
333
    :type: string(default=None)
 
334
 
 
335
    Any extra package signing keys to accept as correctly validate installed 
 
336
    packages.  Typically used for validating ``extra_sources`` packages.
 
337
    
 
338
    .. note:: Cannot have triple-quoted list members.
 
339
 
 
340
 
 
341
[user_info]
 
342
-----------
 
343
User specific settings that are added to a user's :file:`ivle.conf` file 
 
344
inside their jail.
 
345
 
 
346
.. warning::
 
347
 
 
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`.
 
351
 
 
352
.. describe:: login
 
353
 
 
354
    :type: string(default=None)
 
355
 
 
356
    The login name of the user.
 
357
 
 
358
.. describe:: svn_pass
 
359
 
 
360
    :type: string(default=None)
 
361
 
 
362
    The key used to access repositories on the Subversion server.
 
363
 
 
364
 
 
365
Apache configuration
 
366
====================