No description, website, or topics provided.
C++ CMake C

README.md

Centreon Clib

Centreon Clib is an open-source utility library used by some Centreon software. It is a low-level component of the Centreon software suite.

Centreon Clib is released under the Apache Software License version 2 and is endorsed by the Centreon company.

Documentation

The full Centreon Clib documentation is available online here. It is generated from ReST files located in the ./doc/ directory of Centreon Clib sources.

The documentation extensively covers all aspects of Centreon Clib such as installation, compilation, configuration, use and more. It is the reference guide of the software. This README is only provided as a quick introduction.

Installing from binaries

Warning: Centreon Clib is a low-level component of the Centreon software suite. If this is your first installation you would probably want to install it entirely.

Centreon (the company behind the Centreon software suite) provides binary packages for RedHat / CentOS. They are available either as part of the Centreon Entreprise Server distribution or as individual packages on our RPM repository.

Once the repository installed a simple command will be needed to install Centreon Clib.

$# yum install centreon-clib

Fetching sources

The reference repository is hosted at GitHub. Beware that the repository hosts in-development sources and that it might not work at all.

Stable releases are available as gziped tarballs on Centreon's download site.

Compilation (quickstart)

Warning: Centreon Clib is a low-level component of the Centreon software suite. If this is your first installation you would probably want to install it entirely.

This paragraph is only a quickstart guide for the compilation of Centreon Clib. For a more in-depth guide with build options you should refer to the online documentation.

Once the sources of Centreon Clib extracted, got to the ./build/ directory and launch the CMake command. This will look for required dependencies and print a summary of the compilation parameters if everything went fine.

$> cd centreon-clib/build
$> cmake .
...

Now launch the compilation using the make command and then install the software by running make install as priviledged user.

$> make -j 4
...
$# make install

You're done !

Bug reports / Feature requests

The best way to report a bug or to request a feature is to open an issue in GitHub's issue tracker.

Please note that Centreon Clib follows the same workflow as Centreon to process issues.

For a quick resolution of a bug your message should contain :

  • the problem description
  • precise steps on how to reproduce the issue (if you're using Centreon web UI tell us where you click)
  • the expected behavior
  • the Centreon products versions
  • the operating system you're using (name and version)
  • if possible configuration, log and debug files

Contributing

Contributions are much welcome ! If possible provide them as pull-requests on GitHub. If not, patches will do but describe against which version/commit they apply.

For any question or remark feel free to send a mail to the project maintainer : Matthieu Kermagoret (mkermagoret@centreon.com).