← 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: David Coles
  • Date: 2009-12-08 01:55:19 UTC
  • Revision ID: coles.david@gmail.com-20091208015519-7a1y9yaaxpquduzp
Documentation of Apache configuration options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/config.rst
21
21
Configuring IVLE
22
22
****************
23
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`.
 
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.
26
27
 
27
28
Configuration options
28
29
=====================
29
30
 
 
31
Most of the configuration of IVLE is done by editing the file 
 
32
:file:`ivle.conf`, located by default in :file:`/etc/ivle/ivle.conf`. These 
 
33
settings are required as part of the `install process <ref-install>` and for 
 
34
actual running of IVLE.
 
35
 
30
36
[urls]
31
37
------
32
38
Configuration of URLs used by the IVLE webapp.
364
370
 
365
371
Apache configuration
366
372
====================
 
373
Apache is used in IVLE for hosting of the IVLE web application and hosting 
 
374
Subversion repositories over WebDAV. Typically the Subversion repository will 
 
375
run on the Master server and the Web Application will be run on a collection 
 
376
of slaves.  It is also possible to combine the two function together to run as 
 
377
a standalone server.
 
378
 
 
379
 
 
380
Web Application
 
381
---------------
 
382
The IVLE web application runs on Apache using ``mod_python``. An example 
 
383
configuration is provided in the file :file:`examples/config/apache.conf`.
 
384
 
 
385
At minimum the following settings must be specified:
 
386
 
 
387
.. describe:: ServerName
 
388
 
 
389
    Should be the formal hostname of the server, typically one that users will 
 
390
    use to access IVLE. For example, 'ivle.org'.
 
391
 
 
392
.. describe:: ServerAlias
 
393
 
 
394
    Should be set to the value of ``[urls] public_host`` that is specified in 
 
395
    :file:`ivle.conf`. This is to ensure that Apache will correctly handle 
 
396
    requests for the public content.
 
397
 
 
398
.. describe:: SetHandler
 
399
 
 
400
    Must be ``mod_python``
 
401
 
 
402
.. describe:: PythonHandler
 
403
 
 
404
    Must be ``ivle.dispatch``
 
405
 
 
406
.. describe:: PythonOption mod_python.file_session.database_directory
 
407
 
 
408
    Session directory for mod_python. This must be a shared directory between 
 
409
    all Slave servers, in particular when operating through a load balancer.  
 
410
    If not provided then users will encounter inconsistent behavior such as 
 
411
    being thrown back to the login screen after logging in.
 
412
 
 
413
Optional settings are:
 
414
 
 
415
.. describe:: PythonOption mod_python.session.cookie_name
 
416
 
 
417
    The name to be set for cookies rather than the one automatically generated 
 
418
    by mod_python. For example, 'ivle'.
 
419
 
 
420
.. describe:: PythonDebug
 
421
 
 
422
    If this option is set, any uncaught errors from mod_python will be sent to 
 
423
    the browser rather than being sent to the error log. It is recommended 
 
424
    that this setting is only used for development or debugging.
 
425
 
 
426
Subversion Repository
 
427
---------------------
 
428
IVLE also uses Apache to provide HTTP access to user's Subversion repositories 
 
429
using ``mod_dav_svn``. Typically this is run on a single, stand alone server; 
 
430
though it may be run in conjunction with the Web Application.  An example 
 
431
configuration is provided in the file :file:`examples/config/apache-svn.conf`.  
 
432
IVLE will automatically generate password hash and repository permission files 
 
433
that are used to control access to the repositories.
 
434
 
 
435
IVLE expects to find the paths ``users/`` and ``groups/`` at the URL provided 
 
436
by the value of ``[urls] svn_addr`` set in :file:`ivle.conf`. Thus there 
 
437
should be two ``Location`` clauses configured, one for users and one for 
 
438
groups.
 
439
 
 
440
User Repositories
 
441
~~~~~~~~~~~~~~~~~
 
442
 
 
443
.. describe:: DAV
 
444
 
 
445
    Must be ``svn``
 
446
 
 
447
.. describe:: SVNParentPath
 
448
 
 
449
    Directory where user repositories are stored. Should be the value of 
 
450
    ``[path] [[svn]] repo_path`` in :file:`ivle.conf` with 'users' appended.  
 
451
    For example, '/var/lib/ivle/svn/repositories/users'.
 
452
 
 
453
.. describe:: AuthzSVNAccessFile
 
454
 
 
455
    Location of the configuration file used to assign permissions to user 
 
456
    repositories. Should be the same value as ``[path] [[svn]] conf`` in 
 
457
    :file:`ivle.conf`.
 
458
 
 
459
.. describe:: Require
 
460
 
 
461
    Must be ``valid-user``
 
462
 
 
463
.. describe:: AuthType
 
464
 
 
465
    Must be ``Basic``
 
466
 
 
467
.. describe:: AuthName
 
468
 
 
469
    The name that should appear on authentication requests. For example, 'IVLE 
 
470
    Subversion repository'.
 
471
 
 
472
.. describe:: AuthUserFile
 
473
 
 
474
    Location of the password hash file for Subversion users. Should be the 
 
475
    same as the value of ``[path] [[svn]] auth_ivle``. For example, 
 
476
    '/var/lib/ivle/svn/ivle.auth'.
 
477
 
 
478
Group Repositories
 
479
~~~~~~~~~~~~~~~~~~
 
480
 
 
481
.. describe:: DAV
 
482
 
 
483
    Must be ``svn``
 
484
 
 
485
.. describe:: SVNParentPath
 
486
 
 
487
    Directory where user repositories are stored. Should be the value of 
 
488
    ``[path] [[svn]] repo_path`` in :file:`ivle.conf` with 'groups' appended.  
 
489
    For example, '/var/lib/ivle/svn/repositories/groups'.
 
490
 
 
491
.. describe:: AuthzSVNAccessFile
 
492
 
 
493
    Location of the configuration file used to assign permissions to group 
 
494
    repositories. Should be the same value as ``[path] [[svn]] group_conf`` in 
 
495
    :file:`ivle.conf`.
 
496
 
 
497
.. describe:: Require
 
498
 
 
499
    Must be ``valid-user``
 
500
 
 
501
.. describe:: AuthType
 
502
 
 
503
    Must be ``Basic``
 
504
 
 
505
.. describe:: AuthName
 
506
 
 
507
    The name that should appear on authentication requests. For example, 'IVLE 
 
508
    Subversion repository'.
 
509
 
 
510
.. describe:: AuthUserFile
 
511
 
 
512
    Location of the password hash file for Subversion users. Should be the 
 
513
    same as the value of ``[path] [[svn]] auth_ivle``. For example, 
 
514
    '/var/lib/ivle/svn/ivle.auth'.