Axyl Installation
-----------------
Debian users should install Axyl using the Debian packages. This information
is aimed at people installing from a CVS or tarball copy.


If you have acquired Axyl as a tarball, then unpack it somewhere sensible on
the machine which will be serving your websites. The recommended location
is /usr/share/axyl.

Change directory into the 'install' sub-directory and, as root, execute the
shell script 'setup-axyl.sh'.

This script will set up the Axyl configuration in /etc/axyl/axyl.conf.


Having installed Axyl, you will probably want to see what it can do. To set
up the demo website you will need to have Postgresql installed. Axyl will
handle other database flavours, but only Postgres has an automatic installer
at the present time. For the others you can still create websites, but the
business of creating a database is down to you. You are referred to the SQL
definition for Axyl, in the 'db' subdirectory of the Axyl installation.

From the same 'install' directory run the 'create-axyl-website.sh' script,
which will create a brand new empty Axyl website for you.

You can then spawn as many websites as you like, using this script.

If you want to take a tutorial Axyl Tour, then please install the Axyl
documentation package axyl-doc. In the /usr/share/doc/examples directory
you will then find a script 'create-axyl-demo.sh' which will build your
demonstration website, containing the Axyl Tour.


Axyl Documentation Installation
-------------------------------

The recommended location for documentation is /usr/share/doc/axyl-doc.

The main body of the documentation (some 21Mb of it) is a set of web-pages
which document the Axyl Library API. This is to be found in the 'doc/api'
sub-directory, and can be accessed by simply pointing a browser at this
directory (index.html).

The full content of the documentation directory is as follows:

1. api/
      A large body of documentation containing an HTML document-set which
      is a PhpDoc-generated reference manual to all the classes and methods
      used in the Axyl library.

2. axyl_cm_userguide.pdf
      A short PDF which describes getting started entering content using
      the Axyl content management system.

3. lucene-dev-HOWTO
      A brief introduction on how an Axyl developer can develop webpages
      which use the power of the Luceneserver and the Lucene search engine.



# END
