Must be able to wrtie Mason cache directory.
[irspy-moved-to-github.git] / web / conf / README
1 $Id: README,v 1.4 2006-10-24 23:10:43 mike Exp $
2
3 To install the web UI (assuming you're using some version of Apache as
4 your web server):
5
6 -- First, make sure that the IRSpy code runs OK outside the context of
7    a web-server.  Build and test it as you would any Perl module, with
8    "perl Makefile.PL && make && make test".  There's no need to
9    install it, though.  Among the prerequisites are ZOOM-Perl and
10    XML::LibXML::XPathContext: unfortunately neither of these is
11    packaged for Debian, so they must be installed from CPAN.  You'll
12    also need a 2.0-series Zebra installation to run the database.
13
14 -- Make a config file for the host you're on, probably by making a
15    modified copy of apache1.3/xeno.conf
16
17 -- Include this configuration in that of the web server.  For example,
18    if you're using the Apache 1.3 setup that is the default on
19    Debian-based operating systems, go to /etc/apache/conf.d and:
20         # ln -s /usr/local/src/cvs/irspy/web/conf/apache1.3/XXX.conf irspy.conf
21
22 -- Restart the web-server or otherwise tell it about the change to its
23    configurations, for example using "apachectl restart".
24
25 -- Make sure that the web-server's user (often root, www-data or
26    nobody) can write the logs in in the ../logs directory: for
27    example, you might use "chmod ugo+w ."
28
29 -- Make sure that you can read the logs that it generates: for
30    example, you might use:
31         # chmod ugo+r access.log error.log
32
33 -- Make sure you have the HTML::Mason Perl module installed, including
34    all its prerequisites (most notably mod_perl itself).  On
35    Debian-based operating systems, this is as simple as
36         # apt-get install libhtml-mason-perl libapache-request-perl
37
38 -- Ensure that the web server can write the HTML::Mason object
39    directory and cache directory.  For example:
40         chmod ugo+w data/obj data/cache
41
42 That should be everything: just start Zebra, point your browser to the
43 root of your new virtual host, and off you go.
44