Emit bad XML fragment if appendWellBalancedChunk() fails.
[irspy-moved-to-github.git] / web / conf / README
1 $Id: README,v 1.5 2006-10-31 14:17:54 sondberg 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. If you insist
12    on installing these packages as debian packages, first install the
13    tool dh-make-perl, i.e. apt-get install dh-make-perl. Then execute this:
14
15      dh-make-perl --build --cpan XML::LibXML::XPathContext
16
17    After a lot of output has been generated, you should have a .deb file one
18    directory step back. Install it using dpkg -i package-xxx.deb. For the
19    IRSpy package, just cd into the base directory of the source tree, and
20    execute
21
22      dh-make-perl --build
23
24    which will give you a .deb package one directory step back.
25    
26    You'll also need a 2.0-series Zebra installation to run the database.
27
28 -- Make a config file for the host you're on, probably by making a
29    modified copy of apache1.3/xeno.conf
30
31 -- Include this configuration in that of the web server.  For example,
32    if you're using the Apache 1.3 setup that is the default on
33    Debian-based operating systems, go to /etc/apache/conf.d and:
34         # ln -s /usr/local/src/cvs/irspy/web/conf/apache1.3/XXX.conf irspy.conf
35
36 -- Restart the web-server or otherwise tell it about the change to its
37    configurations, for example using "apachectl restart".
38
39 -- Make sure that the web-server's user (often root, www-data or
40    nobody) can write the logs in in the ../logs directory: for
41    example, you might use "chmod ugo+w ."
42
43 -- Make sure that you can read the logs that it generates: for
44    example, you might use:
45         # chmod ugo+r access.log error.log
46
47 -- Make sure you have the HTML::Mason Perl module installed, including
48    all its prerequisites (most notably mod_perl itself).  On
49    Debian-based operating systems, this is as simple as
50         # apt-get install libhtml-mason-perl libapache-request-perl \
51                           libapache-reload-perl
52
53 -- Ensure that the web server can write the HTML::Mason object
54    directory and cache directory.  For example:
55         chmod ugo+w data/obj data/cache
56
57 That should be everything: just start Zebra, point your browser to the
58 root of your new virtual host, and off you go.
59