← Back to branch summary

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

« back to all changes in this revision

Viewing changes to www/README

  • Committer: William Grant
  • Date: 2012-06-28 01:52:02 UTC
  • Revision ID: me@williamgrant.id.au-20120628015202-f6ru7o367gt6nvgz
Hah

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/README
1
 
src directory - README
2
 
======================
3
 
 
4
 
This directory is the root of the IVLE web application proper. It is this
5
 
directory that should be installed into the web server to be executed.
6
 
Navigating to the place this directory is installed shall be the entrypoint
7
 
into the application.
8
 
 
9
 
Note that no files placed in this directory or its subdirectories will be
10
 
directly visible from the web, *except* those files placed in `/media` or its
11
 
subdirectories.
12
 
 
13
 
Apache configuration
14
 
--------------------
15
 
 
16
 
IVLE should be installed into a place on the file system, and then there
17
 
should be a symlink created from Apache. Apache should symlink its IVLE
18
 
directory to the "www" directory, a subdirectory of the IVLE trunk.
19
 
 
20
 
The Apache conf file should have the following directives added to it, which
21
 
configures the site to direct all URLs to the main dispatcher (except for
22
 
files in the /media directory).
23
 
 
24
 
    # IVLE directory configuration
25
 
    # See src/README for instructions and explanation
26
 
    <Directory "/ivle-directory"> 
27
 
        SetHandler mod_python
28
 
        PythonHandler dispatch
29
 
        #PythonDebug On
30
 
        Options FollowSymLinks
31
 
    </Directory>
32
 
    <Directory "/ivle-directory/media"> 
33
 
        SetHandler None
34
 
    </Directory>
35
 
 
36
 
Where `ivle-directory` is the path to root directory of IVLE on the web
37
 
server (the symlink which points to "www").
38
 
 
39
 
Uncomment `PythonDebug On` to turn on debugging.
40
 
 
41
 
Note that this disables directory listings across the whole site (which
42
 
essentially only affects the /media directory).
43
 
 
44
 
Python Site configuration
45
 
-------------------------
46
 
 
47
 
The setup install script automatically configures ivle.pth in the Python site
48
 
packages directory. This section is for if you run into trouble.
49
 
 
50
 
You need to set up IVLE as a Python site to allow importing of IVLE modules.
51
 
If this step is done improperly, you will see "ImportError: No module named
52
 
dispatch".
53
 
 
54
 
Place a file in the Python site packages directory
55
 
(ie. /usr/lib/python2.5/site-packages) called "ivle.pth". In it place a
56
 
single line containing the full path to the "www" directory inside
57
 
trunk in the installed location.
58
 
 
59
 
See http://docs.python.org/lib/module-site.html for information about
60
 
configuring .pth files.
61
 
 
62
 
Application configuration
63
 
-------------------------
64
 
 
65
 
Additional settings must be written to allow IVLE to work (such as the root
66
 
URL and student file space directories). The web application will throw an
67
 
exception if these have not been set up (if conf/conf.py does not exist).
68
 
 
69
 
Run setup.py, a command-line tool, which will interactively create
70
 
conf/conf.py for you.
71
 
 
72
 
Special handling of media directory
73
 
-----------------------------------
74
 
 
75
 
One important exception: Apache must be configured so that the `/media`
76
 
directory and its subdirectories are served directly as-is, with no special
77
 
handling.
78
 
 
79
 
Files in the `/media` directory should be served with the standard MIME types
80
 
(eg. text/html for .html, image/png for .png). **No** server-side script
81
 
handling should take place in the media directory. That is, .py and .php files
82
 
should be simply served up as text/plain or whatever their default MIME type
83
 
is.
84
 
 
85
 
This simply means that the web server should NOT be configured to handle
86
 
scripts anywhere in the ivle directory, except for the above handling code.
87
 
 
88
 
Subdirectories
89
 
--------------
90
 
 
91
 
* /apps - Each plugin application has its own directory.
92
 
* /dispatch - Handler module for the top-level dispatch.
93
 
* /media - Contains files directly served by Apache (see above).
94
 
* /conf - Administrator configuration files (see /conf/README).