ntopng/doc
2020-03-05 15:16:08 +00:00
..
nedge/src Update nEdge docs on supported ethernet protocols 2019-02-19 11:57:11 +01:00
src Typo 2020-03-01 18:37:00 +01: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.beta_features Implement periodic activities status monitor 2020-02-20 16:59:11 +01:00
README.beta_features_anomalies.md Adds readme for anomaly detection 2019-03-05 18:54:51 +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.charts Flow user scripts enhancements 2019-11-20 20:09:45 +01:00
README.compilation Compilation fixes 2020-02-08 10:16:56 +00:00
README.crash Add signal handler commands in crash docs 2019-09-30 10:18:00 +02:00
README.custom_scripts Add the possibility to specify custom scripts parameters 2017-02-17 20:25:40 +01:00
README.developers.flow_state.md Flow dissection code cleanup. 2020-02-17 17:36:06 +01:00
README.developers.hash_entries_lifecycle.md Updates README with new HT rwlocks and trylocks 2019-10-04 19:21:34 +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.eBPF.md Update README.eBPF.md with dispatching to interfaces using event IF_NAME 2019-05-06 11:52:34 +02:00
README.elasticsearch Update README.elasticsearch 2015-09-29 00:36:24 +02:00
README.FlowHashEntry_FSM.dot Finite state machine for flows and hosts 2019-10-10 15:04:28 +02:00
README.FreeBSD Updates FreeBSD readme 2017-06-12 10:46:46 -04:00
README.fritzbox FritzBox: Add info on usage with password-only auth (#3158) 2019-12-29 13:40:04 +01:00
README.geolocation.md Update README.geolocation.md 2020-01-07 17:34:49 +01:00
README.grafana Updates grafana readme 2017-07-21 17:24:14 +02:00
README.historical Added documentation for the historical interface 2015-09-26 10:15:20 +02:00
README.HostHashEntry_FSM.dot Finite state machine for flows and hosts 2019-10-10 15:04:28 +02:00
README.HTTP_AUTHENTICATOR Http allowed nets (#2196) 2019-03-04 15:23:34 +01:00
README.influxdb Added note on index format change 2019-06-28 19:38:58 +02:00
README.inline Deprecated inline capabilities now implemented in nEdge 2018-07-23 10:53:10 +02:00
README.inline_http_configuration Adds deleted nEdge api configuration readme 2018-08-01 11:06:09 +02:00
README.IPv6 Minor text change 2015-09-11 12:24:07 +02:00
README.LDAP Add ntopng authentication methods documentation 2018-12-05 19:23:30 +01:00
README.leaks_detector.md Add shadow dns query to prevent use after free 2020-02-14 11:01:05 +01:00
README.logstash Code revision for issue #1144 (#1147) 2017-04-11 23:24:40 +02:00
README.md Update password reset links 2019-02-04 10:25:08 +01:00
README.mysql Readme for MySQL 5.7 2016-08-03 22:00:09 +02:00
README.nagios REST endpoints update 2019-01-30 14:18:45 +01:00
README.nedge_http_configuration Deprecated inline capabilities now implemented in nEdge 2018-07-23 10:53:10 +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.nindex_debug nIndex debug instructions 2020-03-05 15:16:08 +00: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.profiling Profiling dox 2019-09-09 14:04:25 +02:00
README.prometheus.md Adds the --web.enable-admin-api to the prometheus readme 2019-07-01 23:21:44 +02:00
README.RADIUS Add ntopng authentication methods documentation 2018-12-05 19:23:30 +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.security.md Update README.security.md 2018-06-06 13:02:52 +02:00
README.slack Generalize alerts external report 2018-03-30 20:36:05 +02:00
README.SSL Updates README.SSL 2019-01-15 14:52:30 +01:00
README.systemd.md Adds a systemd doc file 2017-11-21 12:44:46 +01:00
README.users Typo 2019-03-27 10:18:57 +01: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 Refreshes the User Guide: PF_RING interfaces merge 2018-03-01 20:22:22 +01:00
UserGuide.pdf Refreshes the User Guide: PF_RING interfaces merge 2018-03-01 20:22:22 +01:00

Building ntopng

See README.compilation for more information.

Prior to Starting 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 a remote redis server IP address and port or a local socket. We suggest you 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/rest/get/interface/data.lua?ifid=0"

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 ')

Unable to Login

Check out https://www.ntop.org/guides/ntopng/faq.html#cannot-login-into-the-gui

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 option 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