← Back to branch summary

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

« back to all changes in this revision

Viewing changes to src/README

  • Committer: drtomc
  • Date: 2007-12-11 03:26:29 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:25
A bit more work on the userdb stuff.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/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
This directory should be configured specially in Apache such that all requests
 
14
to anywhere in here or any subdirectory should be handled by the Python module
 
15
`dispatch`. Dispatch will process all requests in the entire application.
 
16
 
 
17
Special handling of media directory
 
18
-----------------------------------
 
19
 
 
20
One important exception: Apache must be configured so that the `/media`
 
21
directory and its subdirectories are served directly as-is, with no special
 
22
handling.
 
23
 
 
24
Files in the `/media` directory should be served with the standard MIME types
 
25
(eg. text/html for .html, image/png for .png). **No** server-side script
 
26
handling should take place in the media directory. That is, .py and .php files
 
27
should be simply served up as text/plain or whatever their default MIME type
 
28
is.
 
29
 
 
30
Directory listings should be disabled in the `/media` directory in production,
 
31
and should just present a 403 Forbidden error.
 
32
 
 
33
Subdirectories
 
34
--------------
 
35
 
 
36
* /apps - Each plugin application has its own directory.
 
37
* /dispatch - Handler module for the top-level dispatch.
 
38
* /media - Contains files directly served by Apache (see above).
 
39
* /conf - Administrator configuration files (see /conf/README).