INSTALLATION INSTRUCTIONS FOR OPENVAS-ADMINISTRATOR
===================================================

Please note: The reference system used by most of the developers is Debian
Debian GNU/Linux 'Squeeze' 6.0. The build might fail on any other systems.
Also it is necessary to install dependent development packages.


Prerequisites for openvas-administrator
---------------------------------------

Prerequisites:
* openvas-libraries >= 6.0.0, <7.0.0
* gnutls >= 2.8
* cmake >= 2.6.0
* glib-2.0 >= 2.16
* libuuid (from e2fsprogs)
* pkg-config

Prerequisites for building documentation:
* Doxygen
* xmltoman (optional, for building man page)
* graphviz (the "dot" tool to make the documentation look nicer)


Compiling openvas-administrator
-------------------------------

If you have installed required libraries to a non-standard location, remember to
set the PKG_CONFIG_PATH environment variable to the location of you pkg-config
files before configuring:

    $ export PKG_CONFIG_PATH=/your/location/lib/pkgconfig:$PKG_CONFIG_PATH

Create a build directory and change into it with

    $ mkdir build
    $ cd build

Then configure the build with

    $ cmake -DCMAKE_INSTALL_PREFIX=/path/to/your/installation ..

or (if you want to use the default installation path /usr/local)

    $ cmake ..

This only needs to be done once.  Note: It is assumed that the other
OpenVAS components are installed to the same path.  If not, you need to set
some paths separately, see below for details.

Thereafter, the following commands are useful.

    $ make                # build the administrator
    $ make doc            # build the documentation
    $ make install        # install the build
    $ make rebuild_cache  # rebuild the make system cache


In case you install openvas-administrator to a different path from the other
OpenVAS modules, you might need to set some paths explicitly before running
cmake:

Adjust any values in the Variables section of CMakeLists.txt:
The certificate and key locations in OPENVAS_SERVER_CERTIFICATE,
OPENVAS_SERVER_KEY and OPENVAS_CA_CERTIFICATE may need modifying.
