Skip to content
README.md 4.09 KiB
Newer Older
# Centreon Clib
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

Centreon Clib is an open-source utility library used by some Centreon
software. It is a low-level component of the
[Centreon software suite](https://www.centreon.com).

Centreon Clib is released under the General Public License version 2
and is endorsed by the [Centreon company](https://www.centreon.com).

## Documentation
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

*Coming soon on https://docs.centreon.com*
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

## Installing from binaries
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

> 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](https://docs.centreon.com/current/en/installation/installation-of-a-central-server/using-sources.html).
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

Centreon ([the company behind the Centreon software suite](http://www.centreon.com))
provides binary packages for RedHat / CentOS. They are available either
as part of the [Centreon Platform](https://www.centreon.com/en/platform/)
or as individual packages on [our RPM repository](https://docs.centreon.com/current/en/installation/installation-of-a-poller/using-packages.html).
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

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

```shell
yum install centreon-clib
```
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

## Fetching sources
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

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](https://download.centreon.com).
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

## Compilation
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

This paragraph is only a quickstart guide for the compilation of
Centreon Clib.
### CentOS / Debian / Raspbian
Compilation of these distributions is pretty straightforward.
You'll need to download the project and launch the *cmake.sh* script
to prepare the compilation environment:
```shell
git clone https://github.com/centreon/centreon-clib
cd centreon-clib
./cmake.sh
```

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

```shell
cd build
make
make install
```
### Other distributions
If you are on another distribution, then follow the steps below.
Check if you have these packages installed (Note that packages names
come from CentOS distributions, so if some packages names don't match
on your distribution try to find their equivalent names): git, make,
cmake.
You can now prepare the compilation environment:
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

```shell
git clone https://github.com/centreon/centreon-clib
mkdir -p centreon-clib/build
cd centreon-clib/build
cmake -DWITH_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DWITH_PREFIX_LIB=/usr/lib64 -DWITH_TESTING=On  ..
```
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

Now launch the compilation using the *make* command and then install the
software by running *make install* as priviledged user:
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

```shell
make
make install
```
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

You're done!
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

## Bug reports / Feature requests
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

The best way to report a bug or to request a feature is to open an issue
in GitHub's [issue tracker](https://github.com/centreon/centreon-clib/issues/).
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed

Please note that Centreon Clib follows the
[same workflow as Centreon](https://github.com/centreon/centreon/issues/new/choose)
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
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
  web UI tell us where you click)
- The expected behavior
- The Centreon product**s** version**s**
- 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
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
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
maintainers:

<a href="https://github.com/bouda1"><img src="https://avatars1.githubusercontent.com/u/6324413?s=400&v=4" title="David Boucher" width="80" height="80"></a> &nbsp;
<a href="https://github.com/rem31"><img src="https://avatars.githubusercontent.com/u/73845199?s=460&v=4" title="Rémi Gres" width="80" height="80"></a> &nbsp;
<a href="https://github.com/centreonpm"><img src="https://avatars.githubusercontent.com/u/73105891?s=460&v=4" title="Pierre Margale" width="80" height="80"></a> &nbsp;