← Back to branch summary

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

« back to all changes in this revision

Viewing changes to www/README

Dispatch now generates an index for each plugin type, allowing plugins to
be written which are aware of other plugins, and other plugin types.

All view plugins now subclass from ivle.webapp.base.plugins.ViewPlugin,
as opposed to subclassing BasePlugin directly. This will allow us to
easily re-write console as an OverlayPlugin, and allow future new
plugins types to be created.

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/README
13
13
Apache configuration
14
14
--------------------
15
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
 
16
20
The Apache conf file should have the following directives added to it, which
17
21
configures the site to direct all URLs to the main dispatcher (except for
18
22
files in the /media directory).
21
25
    # See src/README for instructions and explanation
22
26
    <Directory "/ivle-directory"> 
23
27
        SetHandler mod_python
24
 
        PythonHandler dispatch_handler
 
28
        PythonHandler dispatch
25
29
        #PythonDebug On
26
30
        Options FollowSymLinks
27
 
        PythonOption ivle.handlerpath "/ivle-directory"
 
31
        PythonOption mod_python.file_session.database_directory /path/to/shared/sessions
28
32
    </Directory>
29
33
    <Directory "/ivle-directory/media"> 
30
34
        SetHandler None
31
35
    </Directory>
32
36
 
33
37
Where `ivle-directory` is the path to root directory of IVLE on the web
34
 
server.
 
38
server (the symlink which points to "www").
35
39
 
36
40
Uncomment `PythonDebug On` to turn on debugging.
37
41
 
38
42
Note that this disables directory listings across the whole site (which
39
43
essentially only affects the /media directory).
40
44
 
 
45
Python Site configuration
 
46
-------------------------
 
47
 
 
48
The setup install script automatically configures ivle.pth in the Python site
 
49
packages directory. This section is for if you run into trouble.
 
50
 
 
51
You need to set up IVLE as a Python site to allow importing of IVLE modules.
 
52
If this step is done improperly, you will see "ImportError: No module named
 
53
dispatch".
 
54
 
 
55
Place a file in the Python site packages directory
 
56
(ie. /usr/lib/python2.5/site-packages) called "ivle.pth". In it place a
 
57
single line containing the full path to the "www" directory inside
 
58
trunk in the installed location.
 
59
 
 
60
See http://docs.python.org/lib/module-site.html for information about
 
61
configuring .pth files.
 
62
 
41
63
Application configuration
42
64
-------------------------
43
65