Initial revision
[hcoop/zz_old/domtool.git] / src / apache / README
CommitLineData
182a2654
AC
1APACHE VIRTUAL HOST AND WEBALIZER CONFIGURATION
2
3
4This module handles configuration of Apache 1.3
5(http://httpd.apache.org/) virtual hosts, as well as automatically
6setting up Webalizer (http://www.mrunix.net/webalizer/) access
7statistics generation for each virtual host.
8
9Any file in a domain's directory whose name is a valid hostname (i.e.,
10www, myhost, etc.) is taken to be configuration for an Apache
11virtual host. These are separate web sites that Apache serves,
12differentiated based on the hostname contained in a request. The
13following configuration directives may appear on separate lines in
14such files:
15
16 * ServerAdmin email: Set the e-mail address of the vhost's admin to
17email.
18 * User user: Run CGI programs as UNIX user user. The default is
19nobody.
20 * Group group: Run CGI programs with UNIX group group. The
21default is nogroup. You are probably not in nogroup, so you
22probably want to include Group myuser if you also have User
23myuser.
24 * UserDir: Map requests to http://domain/~user/... to the
25corresponding files and directories in user's public_html
26directory, if he has one.
27 * DocumentRoot dir: Use dir as the base directory for site
28content.
29 * RewriteRule ...: These lines are passed verbatim to Apache's
30mod_rewrite (http://httpd.apache.org/docs/mod/mod_rewrite.html).
31 * Alias urldir realdir: Serve requests for things in directory
32urldir out of realdir.
33 * ScriptAlias urldir realdir: Like the above, but for scripts. It's
34like the same-named Apache directive.
35 * SSI: Enable server-side includes.
36 * ServerAlias hostname: Serve requests for full hostname hostname
37with this same vhost. There must exist an appropriate host.aliased
38file corresponding to hostname. For example, if hostname is
39my.web.site, the file /etc/domains/site/web/my.aliased must exist.
40 * WebalizerUsers userlist: Only allow users in space-separated
41userlist to view the Webalizer statistics for this vhost.
42 * AbuPrivate: Force visitors to this vhost to log in with their
43web accounts. The password file used for this is indicated by
44passwdFile in config.sml. Deny access if a correct username and
45password are not provided.
46 * CGI dir: Mark filesystem directory dir as containing executable
47CGI scripts/programs.
48 * Default: Where the configuration file is describing
49host.domain, this sets domain by itself as an alternate name for
50this vhost.
51 * ErrorDocument code url: This is the Apache ErrorDocument
52directive verbatim.
53 * HTML realdir: Serve every file in realdir as HTML.
54
55The src/webpasswd/ directory contains a handy tool for allowing users
56to set their own passwords and no one else's in an Apache password
57file. It's helpful to use along with the AbuPrivate and WebalizerUsers
58options.
59
60
61The module generates a file vhosts.conf containing only virtual host
62configuration. It is intended to be included by the standard
63httpd.conf after all server-wide configuration and a default virtual
64host block.