Masterkey-Admin
===============

This module provides a library, Masterkey::Admin, and the relevant
associated web scaffolding to provide an administrative user-interface
to Index Data's MasterKey metasearcher, using the Web Services API of
the Torus (Translucent Recent Store), which is described at
	http://twiki.indexdata.dk/cgi-bin/twiki/view/ID/NellcoTargetAdmin
for those who have permission.


INSTALLATION

To install the libraries in this module, type the following:

	perl Makefile.PL
	make
	make test
	make install

But that's probably not what you want: it installs the libraries, but
that in itself doesn't make the application visible to Apache.  Since
the purpose of this library is to enable an HTML::Mason-based
web-site, to get that working you will need to follow the instructions
in the file:
	web/config/apache2.0/README
instead.


DEPENDENCIES

Dependent Perl modules are listed in Makefile.PL's PREREQ_PM setting,
so I have no idea why it is also conventional to repeat them here.
Whatever happened to the DRY principle?

You will also need a bunch of other stuff, including Apache2,
mod_perl2 and HTML::Mason, if you want to run the Admin web sites.

DEBIAN DEPENDENCIES

If you have a Debian-based operating system, you can get what you need
by installing the following packages from the operating system's
package store, using apt-get:

sudo apt-get install \	
	libapache2-mod-perl2 \
	libhtml-mason-perl \
	libapache2-request-perl \
	libapache2-mod-apreq2 \
	libxml-simple-perl \
	libfreezethaw-perl \
	libnet-z3950-zoom-perl \
	libhtml-tagcloud-perl \
	libfile-slurp-perl \
	libxml-libxml-perl \
	libio-string-perl \
	libxml-libxml-simple-perl


You will also need the libxml-libxml-simple-perl package provided in
the modules directory -- that one you can't install from your
operating system, as neither Debian nor Ubuntu has a package for it.
Install it with:
	$ sudo dpkg -i libxml-libxml-simple-perl_0.13-1_all.deb

Don't forget to a2enmod apreq and restart Apache2!


CONFIGURATION

A single installation of this software can support an arbitrary number
of MKAdmin applications.  Each such application run as a separate
virtual site: if you're using Apache2, you can see examples of the
necessary site-configuration fragments in web/config/apache2.0/

The key part of each site's web-server configuration is the setting of
the MAconfigdir environment variable to the name of a directory where
application-level configuration is found.  Several such application
configuration directories are included in the config directory: see
the README in that directory for more detail.


COPYRIGHT AND LICENCE

Copyright (C) 2008-2010 by Index Data Aps.

At the moment, this software remains proprietary, and may not be
inspected, used, deployed, enjoyed, contemplated, inspected, built,
installed, reverse-engineered or meditated on without the express
written permission on Index Data, carved on tablets of stone and
signed by a two-thirds majority of the members of the U.S. Supreme
Court.

We hope to relax these conditions in the future.

