ntopng/doc
Bogdan Perian dbcec19d2b Logstash code improvements (#1143)
* Logstash code cleanup

* removed unnecesary trace warnings from LS code

* sync

* Logstash readme updated + code cleanup

* changed back to default bulk mechanism

* Logstash extension code improvements

* PR #1143 revision
2017-04-10 14:30:07 +02:00
..
doxygen.conf.in Fixes spellings and typos 2017-03-06 17:54:48 +01:00
mainpage.dox Initial import from SVN 2015-04-30 12:22:35 +02:00
README.captive_portal Fixes spellings and typos 2017-03-06 17:54:48 +01: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 Added missing which dependency on some minimal CentOS-based distro 2017-02-25 09:00:05 +01:00
README.custom_scripts Add the possibility to specify custom scripts parameters 2017-02-17 20:25:40 +01: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 Enhanced flashstart readme 2017-04-01 21:27:49 +02:00
README.FreeBSD Host name resolution is disabled for remote hosts when set in preferences 2017-02-24 17:02:09 +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.inline Fixes spellings and typos 2017-03-06 17:54:48 +01:00
README.IPv6 Minor text change 2015-09-11 12:24:07 +02:00
README.LDAP Fixes spellings and typos 2017-03-06 17:54:48 +01:00
README.logstash Logstash code improvements (#1143) 2017-04-10 14:30:07 +02:00
README.md Fixes spellings and typos 2017-03-06 17:54:48 +01:00
README.mysql Readme for MySQL 5.7 2016-08-03 22:00:09 +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 Extended readme to explain how to improve ntopng performance with netfilter 2017-03-19 19:56:55 +01:00
README.OpenBSD Adjustments to obtain an OpenBSD build 2017-02-09 19:11:06 +01:00
README.pfsense Updates divert Readme 2017-02-15 13:23:50 +01:00
README.raspberry Fixes spellings and typos 2017-03-06 17:54:48 +01:00
README.redis Added README for redis setup 2015-08-05 14:52:14 +02:00
README.slack Learn how to integrate slack with ntopng 2016-11-22 18:09:00 +01:00
README.SSL Fixes spellings and typos 2017-03-06 17:54:48 +01:00
README.users Update README.users (#1102) 2017-03-28 10:29:14 +02:00
README.vagrant Reworked README files 2015-05-18 09:47:04 +02:00
README.valgrind Added notes on how to enable valgrind with ntopng 2016-06-14 18:38:54 +02:00
README.windows Reworked README files 2015-05-18 09:47:04 +02:00
README.zmq Updated ZMQ readme with collector mode 2016-07-19 19:43:47 +02:00
UserGuide.pages User Guide: Captive Portal 2017-02-03 12:52:45 +01:00
UserGuide.pdf User Guide: Captive Portal 2017-02-03 12:52:45 +01:00

Building ntopng

See README.compilation for more information.

Prior to Start ntopng

Please make sure that you have redis server installed and active on the same host where ntopng will be running. If you plan to use a remote redis, please consider using the --redis option to specify the remote redis server IP address and port. We suggest you to run redis as a service so that you do not have to start it every time you want to use ntopng.

Using ntopng as a flow collector

In order to use ntopng as a flow collector with nprobe you need to start the apps as follows:

  • collector ntopng -i tcp://127.0.0.1:5556

  • probe (nProbe) nprobe --zmq "tcp://*:5556" -i ethX -n none -b 2

You can instruct ntopng to merge onto the same interface multiple endpoints by separating them with a comma. Example:

ntopng -i tcp://127.0.0.1:5556,tcp://192.168.0.1:5556

Creating Hierarchies of ntopng Instances

You can create a hierarchy of ntopngs (e.g. on a star topology, where you have many ntopng processes on the edge of a network and a central collector) as follows:

  • Remote ntopng's Host 1.2.3.4 ntopng -i ethX -I "tcp://:3456" Host 1.2.3.5 ntopng -i ethX -I "tcp://:3457" Host 1.2.3.6 ntopng -i ethX -I "tcp://*:3458"

  • Central ntopng ntopng -i "tcp://1.2.3.4:3456" -i "tcp://1.2.3.5:3457" -i "tcp://1.2.3.6:3458"

Note that on the central ntopng you can add "-i ethX" if you want the central ntopng monitor a local interface as well.

Accessing ntopng URLs from command line tools (no web browser)

You need to specify the user and password as specified below (please note the space in the cookie). Note that you can optionally also specify the interface name.

curl --cookie "user=admin; password=admin" "http://127.0.0.1:3000/lua/network_load.lua?ifname=en0"

Using ntopng from Windows

  1. Remember to start the redis server prior to start ntopng
  2. You must start ntopng as a service using the "Services" control panel

Defaults

The ntopng default user is 'admin' (without ') and the default password is also 'admin' (without ')

Resetting admin user password

  1. shutdown ntopng
  2. redis-cli del ntopng.user.admin.password
  3. restart ntopng and now the admin password has been reset

Running multiple ntopng instances on the same host

In order to run multiple ntopng instances independently (i.e. they do not interfere each other), each instance must:

  1. Set a different value for -d
  2. Set a different database id for -r
  3. Use a different http port iwth -w

Example: ntopng -d /path1 -r 127.0.0.1:6379@1 -w 3001 ntopng -d /path2 -r 127.0.0.1:6379@2 -w 3002 ...

Using Interface Views

Suppose you want to start ntopng as follows "-i eth0 -i eth1". ntopng will show you traffic of these two interfaces without any merge so you can see exactly what happens on each interface. If you also need an aggregated view of both interfaces you can start ntopng as "ntopng -i eth0 -i eth1 -i view:eth0,eth1" so ntopng will create a virtual interface that merges information from the two physical interfaces.

Using ntopng behind a Proxy

If you have many ntopng instances that you want to mask behind a proxy the -Z is what you look for. See the man page for more information.

Traffic with sampling rate

If you apply a sampling rate to capture traffic on an interface, say x100, the traffic volume you see on ntopng will be 100 times smaller. In order to simulate more traffic to match real traffic volume, you can apply a scaling factor to the size of each received packet. The scaling factor can be specified through the UI, into the interface settings.

Debugging ntopng

handle SIGPIPE nostop noprint pass