Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
root committed Oct 20, 2021
1 parent 370c206 commit dba8cdf
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,30 @@ Installation

There are currently no binary packages of Meer available. However, installation from source is pretty straightforward.

Prerequisites
-------------
Required Prerequisites
----------------------

Before compiling and installing Meer, you will need to determine where you want your data to reside. Currently, Meer supports MariaDB,
MySQL and PostgreSQL. In order to build Meer, you will need one or more of these installed with all development files. For
example, Ubuntu/Debian systems can install via:
Meer uses a YAML configuration file. This means that Meer will need libyaml installed on the system. On Ubuntu/Debian systems, this can be installed via:

.. option:: apt-get install mariadb-dev # For MariaDB
.. option:: apt-get install libyaml-dev

.. option:: apt-get install libmysqlclient-dev # For MySQL
Meer uses `JSON-C <https://github.com/json-c/json-c>`_ to parse JSON (EVE) output from Sagan and Suricata. On Ubuntu/Debian systems, this prerequisite can be installed via:

.. option:: apt-get install libpq-dev # For PostgreSQL
.. option:: apt-get install libjson-c-dev

Meer uses a YAML configuration file. This means that Meer will need libyaml installed on the system. On Ubuntu/Debian
systems, this can be installed via:
Optional Prerequisites
----------------------

.. option:: apt-get install libyaml-dev
MariaDB/MySQL/PostgreSQL
~~~~~~~~~~~~~~~~~~~~~~~~

Meer uses `JSON-C <https://github.com/json-c/json-c>`_ to parse JSON output from Sagan and Suricata. On Ubuntu/Debian
systems, this prerequisite can be installed via:
Before compiling and installing Meer, you will need to determine where you want your data to reside. Currently, Meer supports MariaDB, MySQL and PostgreSQL. In order to build Meer, you will need one or more of these installed with all development files. For example, Ubuntu/Debian systems can install via:

.. option:: apt-get install libjson-c-dev
.. option:: apt-get install mariadb-dev # For MariaDB

.. option:: apt-get install libmysqlclient-dev # For MySQL

.. option:: apt-get install libpq-dev # For PostgreSQL


Source
Expand Down

0 comments on commit dba8cdf

Please sign in to comment.