This directory and its children contain LibPreludeDB, a library for using
the Prelude database.

Changes: if you wish to contribute a change which is a significant one
in terms of the amount of code changes, please be aware that CS-SI wishes
to retain copyright of the PreludeDB library. Therefore you will have to
sign over copyright ownership of your code to CS-SI before we can include
your changes in the main source tree.

Before you start modifying anything for real, you should probably join
the prelude-devel mailing list and send a mail describing what you want to
do and how you want to do it so you don't waste time working on something we
can't integrate. This also allows us to keep track of what's being worked on
so efforts aren't duplicated.

Please also read the information in the file LICENSE.README.

This directory and its children contain LibPreludeDB, a library for using
the Prelude database.

Copyright (C) 2005-2015 CS-SI. All rights reserved.

This library is made available under a dual licensing scheme.

If you link LibPreludeDB against other code all of which is itself
licensed under the terms of the GNU General Public License version 2
dated June 1991 ("GPL v2") or compatible, then you may use LibPreludeDB
under the terms of the GPL v2,as appearing in the file COPYING.  If the
file COPYING is missing, you can obtain a copy of the GPL v2 from the
Free Software Foundation Inc., 51 Franklin St, Fifth Floor, Boston, MA
02110-1301, USA.

For any other uses of LibPreludeDB, you must first obtain a commercial license
from CS-SI.  Please send a mail to contact.prelude@c-s.fr for
information about commercial licensing.

Please also read the information in the file HACKING.README.

PreludeDB Library (http://www.prelude-siem.com)
PreludeDB is brought to you by CS-SI (http://www.c-s.fr).


PreludeDB Library Overview
========================

The PreludeDB Library provides an abstraction layer upon the type and the format
of the database used to store IDMEF alerts.
It allows developers to use the Prelude IDMEF database easily and efficiently without worrying about SQL,
and to access the database independently of the type/format of the database.



Dependencies
============

   Libprelude must be installed first.

   For Redhat based systems (CentOS, Fedora, etc.)
       MySQL Plugin        :    mysql-devel
       PostgresSQL Plugin  :    postgresql-devel
       SQLite Plugin       :    sqlite-devel

   For Debian systems
       MySQL Plugin        :    libmysqlclient-dev
       PostgresSQL Plugin  :    libpq-dev
       SQLite Plugin       :    libsqlite3-dev



IRC
===

If there's something you just can't find out elsewhere, you want to
give feedback directly to the authors or you're just bored, visit
#prelude on irc.freenode.net



Get Support
===========


Prelude-user forums can be accessed at:
	https://www.prelude-siem.org/projects/prelude/boards


Commercial Support is available through the CS-SI company:
	http://www.prelude-siem.com, contact.prelude@c-s.fr



Help development
================

1. SUBMITTING PATCHES

The Prelude source is constantly changing. If you want to submit a patch,
please do so from the most recent GIT source tree, subscribe to the
prelude-devel forum and post your patch with a description of functionality.
You can also attach patches to bugs on

        https://www.prelude-siem.org


2. BUGS

If you find any bugs, please report them to:

	https://www.prelude-siem.org

Please make sure that what you're reporting is actually a BUG and not
a problem on your side.


3. SUGGESTIONS

Subscribe to prelude-devel and give us your suggestions.



How to install the PreludeDB Library
==================================


If you don't want to build the PreludeDB Library yourself, some distributions include binary packages for prelude.

If you want to build PreludeDB, unpack the tarball and cd into the
newly created directory. Then type :

	./configure
	make

If everything works, su to root and type:

	make install