ntopng/doc
2016-04-25 09:41:46 +02:00
..
doxygen.conf.in Initial import from SVN 2015-04-30 12:22:35 +02:00
mainpage.dox Initial import from SVN 2015-04-30 12:22:35 +02:00
README.bridging Added notes about ZC interfaces 2015-10-23 12:04:07 +02:00
README.cento Notes on how to use nProbe cento with ntopng for realtime traffic monitoring 2016-01-07 19:56:07 +01:00
README.compilation Update license link 2016-04-25 09:41:46 +02:00
README.docker_openstack Reworked README files 2015-05-18 09:47:04 +02:00
README.doxygen Added documentation for the historical interface 2015-09-26 10:15:20 +02:00
README.elasticsearch Update README.elasticsearch 2015-09-29 00:36:24 +02:00
README.flashstart Reworked -k parameter to introduce support for flashstart service (work in progress) 2015-12-05 11:55:48 +01:00
README.FreeBSD Added FreeBSD compilation README 2015-12-15 09:11:07 +01:00
README.historical Added documentation for the historical interface 2015-09-26 10:15:20 +02:00
README.httpbl Reworked -k parameter to introduce support for flashstart service (work in progress) 2015-12-05 11:55:48 +01:00
README.IPv6 Minor text change 2015-09-11 12:24:07 +02:00
README.nagios Added readme for highlighting how to use ntopng with nagios plugins 2015-05-30 19:03:16 +02:00
README.netbeans.pages added tutorial to develop ntopng in netbeans 2015-09-03 19:50:49 +02:00
README.netbeans.pdf added tutorial to develop ntopng in netbeans 2015-09-03 19:50:49 +02:00
README.netfilter Extends netfilter README file 2016-04-14 10:35:18 +02:00
README.ntopng Created README for compiling ntopng frion source 2015-11-05 16:55:46 +01:00
README.pfsense Renamed for better understanding whatis this file about 2016-02-07 21:23:14 +01:00
README.redis Added README for redis setup 2015-08-05 14:52:14 +02:00
README.SSL updated examples from -sha1 to -sha256 2015-10-09 22:15:24 +02:00
README.users Reworked README files 2015-05-18 09:47:04 +02:00
README.vagrant Reworked README files 2015-05-18 09:47:04 +02:00
README.windows Reworked README files 2015-05-18 09:47:04 +02:00
README.zmq Added readme for using ZMQ (for flow collection) behind a firewall 2016-02-27 20:42:44 +01:00
UserGuide.docx Word version of the manual 2016-02-14 10:55:50 +01:00
UserGuide.pages Extends the UserGuide with Windows docs 2016-04-15 18:30:30 +02:00
UserGuide.pdf Extends the UserGuide with Windows docs 2016-04-15 18:30:30 +02:00

(sFlow/NetFlow) Flow Collection via ZMQ
---------------------------------------
As described in http://www.ntop.org/nprobe/why-nprobejsonzmq-instead-of-native-sflownetflow-support-in-ntopng/
ntopng does not natively handle netflow but it rather does that via ZMQ.

In ZMQ we have reverted the NetFlow collector/probe paradigm. When used via ZMQ ntopng connects to the
flow source (nProbe in this case) it subscribes to the specified topic so that only the interesting
information is received.

Example:
Suppose you start nprobe on host IP 1.2.3.4 and ntopng on host IP 5.6.7.8. Instruct nProbe to
create a ZMQ endpoint on all host interfaces at port 5556. In this case nProbe waits for
ntopng connections. This way you can attach/detach as many ntopng instances you like
without having to reconfigure nProbe
# nprobe --zmq "tcp://*:5556" -i eth1 -n none

Then you need to start ntopng to connect to the above doing
# ntopng -i tcp://1.2.3.4:5556

NOTE: The --zmq parameter has a double dash '-'


Using ZMQ Behind a Firewall
---------------------------
The above ZMQ communication paradigm might not work in case there is a firewall between nProbe
and ntopng.

* Scenario A
- Both nProbe and ntop are on the same private network (firewall protected)
The firewall does not create any trouble to ZMQ communications.

* Scenario B
- nProbe is on a public network/IP
- ntopng is on a private network/IP protected by a firewall
In this case the ZMQ paradigm works well as ntopng connects to nProbe.

* Scenario C
- nProbe is on a private network/IP
- ntopng is on a public network/IP protected by a firewall
In this case the ZMQ paradigm does not work as the firewall prevents ntopng (connection initiator)
to connect tp nProbe. In this case you need to revert the ZMQ paradigm by swapping
roles of nProbe/ntopng. This can be done as follows. Suppose nprobe runs n host IP 192.168.1.100 and
ntopng on host IP 46.101.x.y. In this case you need to start the applications as follows

# nprobe --zmq-probe-mode --zmq "tcp://46.101.x.y:5556" -i eth1 -n none
# ntopng --zmq-collector-mode -i "tcp://*:5556"

In essence you revert the roles of nProbe and ntopng. In this setup they behave as 
NetFlow/IPFIX probes do.