ntopng/doc
2021-04-22 10:21:34 +02:00
..
nedge/src Add links to silicom bypass adapters 2020-09-10 09:12:45 +02:00
src Update ntopng conf on opnsense picture 2021-04-22 10:21:34 +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.alerts.developer.md Additional alerts documentation updates 2020-09-04 10:48:17 +02:00
README.beta_features Removes experimental code for timeseries delta 2021-02-23 19:09:07 +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 Refactors NtopngUtils into NtopUtils 2020-08-18 15:10:04 +02:00
README.compilation Update js. Fix doc. 2021-03-08 11:23:30 +01:00
README.crash.md Update crash README 2021-01-20 10:44:08 +01:00
README.CSRF.md Fix typos in documentation (#4311) 2020-08-19 11:51:11 +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 Standardize spelling GUI in docs 2020-08-17 16:45:17 +09:00
README.docker_openstack Updated instructions 2020-08-06 09:09:07 +02:00
README.doxygen Added documentation for the historical interface 2015-09-26 10:15:20 +02:00
README.eBPF.md Fix typos in documentation (#4311) 2020-08-19 11:51:11 +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.fritzbox Fix typos in documentation (#4311) 2020-08-19 11:51:11 +02:00
README.geolocation.md Minor change 2020-08-03 19:13:13 +02:00
README.grafana Added grafana example dashboard 2020-07-29 22:18:38 +02:00
README.historical Added documentation for the historical interface 2015-09-26 10:15:20 +02:00
README.host_pools_migration.md Implements global host pools 2020-07-01 12:02:09 +02:00
README.HostHashEntry_FSM.dot Finite state machine for flows and hosts 2019-10-10 15:04:28 +02:00
README.HTTP_AUTHENTICATOR Fix typos in documentation (#4311) 2020-08-19 11:51:11 +02: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 Fix typos in documentation (#4311) 2020-08-19 11:51:11 +02:00
README.IPv6 Minor text change 2015-09-11 12:24:07 +02:00
README.LDAP Fix typos in documentation (#4311) 2020-08-19 11:51:11 +02:00
README.leaks_detector.md Update README.leaks_detector.md 2020-08-22 15:55:49 +02:00
README.logstash Code revision for issue #1144 (#1147) 2017-04-11 23:24:40 +02:00
README.md Fix typos in documentation (#4311) 2020-08-19 11:51:11 +02:00
README.mysql.5.7+.md Typo 2020-03-25 12:08:52 +01:00
README.nagios.md Update and rename README.nagios to README.nagios.md 2020-07-27 21:55:49 +02:00
README.nedge_http_configuration Fix typos in documentation (#4311) 2020-08-19 11:51:11 +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.RADIUS Standardize spelling Linux in docs 2020-08-17 16:45:26 +09:00
README.raspberry Standardize spelling Ethernet in docs 2020-08-17 16:45:47 +09:00
README.redis Fix typos in documentation (#4311) 2020-08-19 11:51:11 +02:00
README.run_two_instances Readme for running multiple ntopng instances 2020-11-10 22:57:45 +01:00
README.security.md Fix typos in documentation (#4311) 2020-08-19 11:51:11 +02:00
README.slack Generalize alerts external report 2018-03-30 20:36:05 +02:00
README.snmp Correct typos in docs 2020-08-17 16:45:47 +09:00
README.SSL Updated SSL instructions removing outdated information 2020-09-28 13:03:11 +02:00
README.systemd.md Adds a systemd doc file 2017-11-21 12:44:46 +01:00
README.users Standardize spelling GUI in docs 2020-08-17 16:45:17 +09: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.vyos.md Typos 2020-11-18 18:11:21 +01: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

Building ntopng

See README.compilation for more information.

Prior to Starting ntopng

Please make sure that you have a Redis server installed and active on the same host where ntopng will be running. If you plan to use a remote Redis server, 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 GUI, into the interface settings.

Debugging ntopng

handle SIGPIPE nostop noprint pass