openvas-administrator
=====================

This is the administrator module for the Open Vulnerability Assessment
System (OpenVAS). It is intended to simplify the configuration and
administration of an OpenVAS server both on a local installation as well as on a
remote system.

   PLEASE NOTE:
   This module is currently in an early development stage and not intended for
   production use.

For more information, please refer to the OpenVAS website available at
http://www.openvas.org/.

Please see the file COPYING for the license information.

Please refer to the instructions provided below if you want to install
openvas-administrator. If you are not familiar or comfortable with the
procedure described below, we recommend that you use a binary package provided
by your distribution. Information regarding available binary packages is
available from the OpenVAS website.

Note that you will need the openvas-libraries module to compile
openvas-administrator. Further information about this module is available from
the OpenVAS website as well.

If you have any question or suggestions, please feel free to use the mailing
list and the IRC chat to contact the OpenVAS developers.

Please use the OpenVAS bug tracker located at http://bugs.openvas.org/ to report
bugs.


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

Run

$ cmake .

to set up the compilation environment.
During configuration, error messages may show up if libraries and applications
needed to compile openvas-administrator are not present on your system
or do not meet the version requirements.
In this case, resolve the issues reported and run cmake again.

If you want to install openvas-administrator into a different hierarchy,
you may want to use the prefix option during configuration:

$ cmake -DCMAKE_INSTALL_PREFIX=/opt/openvas .

Please note that this should be the same prefix you used to configure
openvas-server.

More information about the configuration options is available through the help
option:

$ ./cmake --help

Once you have configured openvas-administrator successfully, you can
start the compilation by executing the following command:

$ make

To install openvas-administrator, you can use the following command:

$ make install

Please note that you may have to execute this command as root, especially if you
have specified a prefix for which your user does not have full permissions.

Running openvas-administrator
-----------------------------

Once you have successfully compiled and installed openvas-administrator,
you can start the application with the following command:

$ openvasad

Please use the following command to learn more about
openvas-administrator:

$ openvasad --help


If you encounter problems, the output of the command "openvasad --version" may
contain useful information. Please have this output ready when contacting the
OpenVAS developers through the OpenVAS mailing list or the online chat or
submitting bug reports at http://bugs.openvas.org/ as it may help to pinpoint
the source of your issue.

Testing
-------

There are some tests under src/tests.  To run them, start your openvasad,
for example with

    openvasad --port 9999

then set the environment variables for the user and password

    export OPENVAS_TEST_USER=user_created_by_openvas-adduser
    export OPENVAS_TEST_PASSWORD=that_user's_password

and optionally for the host and/or port

    export OPENVAS_TEST_HOST=host.example.org
    export OPENVAS_TEST_PORT=9999

and then run all the tests

    make test

or any one of the tests, for example

    src/tests/oap_help_0
