mirror of
https://github.com/nfstream/nfstream.git
synced 2026-05-20 09:23:51 +00:00
38 lines
No EOL
1.1 KiB
ReStructuredText
38 lines
No EOL
1.1 KiB
ReStructuredText
.. nfstream documentation master file, created by
|
|
sphinx-quickstart on Sat Oct 19 16:26:59 2019.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
.. image:: asset/logo_doc.png
|
|
:scale: 100%
|
|
:align: center
|
|
|
|
#############
|
|
|
|
Main Features
|
|
#############
|
|
|
|
|
|
* **Performance:** **nfstream** is designed to be fast (pypy3 support) with a small CPU and memory footprint.
|
|
* **Layer-7 visibility:** **nfstream** deep packet inspection engine is based on nDPI_ library. It allows nfstream to perform reliable_ encrypted applications identification and metadata extraction (e.g. TLS, SSH, DNS, HTTP).
|
|
* **Flexibility:** add a flow feature in 2 lines as an NFPlugin_.
|
|
* **Machine Learning oriented:** add your trained model as an NFPlugin_.
|
|
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Table of Contents:
|
|
|
|
installation
|
|
architecture
|
|
get_started
|
|
plugins
|
|
contributing
|
|
changelog
|
|
|
|
|
|
.. _nDPI: https://www.ntop.org/products/deep-packet-inspection/ndpi/
|
|
.. _NFPlugin: https://nfstream.readthedocs.io/en/latest/plugins.html
|
|
.. _reliable: http://people.ac.upc.edu/pbarlet/papers/ground-truth.pam2014.pdf |