Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #93

Merged
merged 3 commits into from
Mar 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
✨ *Tip: Are you sure your NetFlow/IPFIX probe is working correctly? Be sure with our other project:* |FlowTest|_

-----

.. _FlowTest: https://github.com/CESNET/FlowTest
.. |FlowTest| replace:: *🌊 FlowTest*

============= =============
Master branch |BuildMaster|
------------- -------------
Expand Down Expand Up @@ -60,6 +67,20 @@ network interface and a port. Multiple instances of these plugins can run concur

\* Must be installed individually due to extra dependencies

How to install
--------------

If you are running a RHEL system or one of its derivatives, the easiest way to
get IPFIXcol installed is using our Copr package repository.

.. code-block:: bash

$ dnf install 'dnf-command(copr)' # Extra step necessary on some systems
$ dnf copr enable @CESNET/IPFIXcol
$ dnf install ipfixcol2

For other systems, follow the build instructions below.

How to build
------------

Expand Down Expand Up @@ -130,14 +151,6 @@ be stored. The structure of the configuration is described
of the collector are given in the section
"`Example configuration files <doc/sphinx/configuration.rst#example-configuration-files>`_".

Coming soon
-----------
- Runtime reconfiguration (improved compared to the previous generation)
- Input plugins for files (IPFIX, fds, etc.)
- Flow filtration and flow profiling
- Flow aggregation
- RPM/DEB packages

FAQ
--------------

Expand Down
Loading