add note that this README is outdated
[irspy-moved-to-github.git] / web / conf / README
1 !!!Note: most part of this document is outdated!!!
2
3 Please have a look at the README in the top-level directory.
4
5 April 2010, Wolfram
6
7 $Id: README,v 1.5 2006-10-31 14:17:54 sondberg Exp $
8
9 To install the web UI (assuming you're using some version of Apache as
10 your web server):
11
12 -- First, make sure that the IRSpy code runs OK outside the context of
13    a web-server.  Build and test it as you would any Perl module, with
14    "perl Makefile.PL && make && make test".  There's no need to
15    install it, though.  Among the prerequisites are ZOOM-Perl and
16    XML::LibXML::XPathContext: unfortunately neither of these is
17    packaged for Debian, so they must be installed from CPAN. If you insist
18    on installing these packages as debian packages, first install the
19    tool dh-make-perl, i.e. apt-get install dh-make-perl. Then execute this:
20
21      dh-make-perl --build --cpan XML::LibXML::XPathContext
22
23    After a lot of output has been generated, you should have a .deb file one
24    directory step back. Install it using dpkg -i package-xxx.deb. For the
25    IRSpy package, just cd into the base directory of the source tree, and
26    execute
27
28      dh-make-perl --build
29
30    which will give you a .deb package one directory step back.
31    
32    You'll also need a 2.0-series Zebra installation to run the database.
33
34 -- Make a config file for the host you're on, probably by making a
35    modified copy of apache1.3/xeno.conf
36
37 -- Include this configuration in that of the web server.  For example,
38    if you're using the Apache 1.3 setup that is the default on
39    Debian-based operating systems, go to /etc/apache/conf.d and:
40         # ln -s /usr/local/src/cvs/irspy/web/conf/apache1.3/XXX.conf irspy.conf
41
42 -- Restart the web-server or otherwise tell it about the change to its
43    configurations, for example using "apachectl restart".
44
45 -- Make sure that the web-server's user (often root, www-data or
46    nobody) can write the logs in in the ../logs directory: for
47    example, you might use "chmod ugo+w ."
48
49 -- Make sure that you can read the logs that it generates: for
50    example, you might use:
51         # chmod ugo+r access.log error.log
52
53 -- Make sure you have the HTML::Mason Perl module installed, including
54    all its prerequisites (most notably mod_perl itself).  On
55    Debian-based operating systems, this is as simple as
56         # apt-get install libhtml-mason-perl libapache-request-perl \
57                           libapache-reload-perl
58
59 -- Ensure that the web server can write the HTML::Mason object
60    directory and cache directory.  For example:
61         chmod ugo+w data/obj data/cache
62
63 That should be everything: just start Zebra, point your browser to the
64 root of your new virtual host, and off you go.
65