ntopng/doc
simonemainardi f6567a5758
Updates README.compilation
Adds Fedora 30 readline-devel dep

Fixes #4023
2020-06-11 10:07:09 +02:00
..
nedge/src Typo fix 2020-05-29 13:04:42 +02:00
src Add ability to listen for syslog connections on TCP and UDP at the same time (fix #4028) 2020-06-10 17:59:27 +02:00
doxygen.conf.in
mainpage.dox
README.beta_features Debug flags doc update 2020-04-10 13:58:15 +00:00
README.beta_features_anomalies.md Adds readme for anomaly detection 2019-03-05 18:54:51 +01:00
README.cento
README.charts Refactors graph_utils and nv_graph_utils 2020-04-10 09:47:32 +02:00
README.compilation Updates README.compilation 2020-06-11 10:07:09 +02:00
README.crash Add signal handler commands in crash docs 2019-09-30 10:18:00 +02:00
README.CSRF.md Additional notes on CSRF 2020-06-03 17:42:38 +02:00
README.custom_scripts
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
README.doxygen
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
README.FlowHashEntry_FSM.dot Finite state machine for flows and hosts 2019-10-10 15:04:28 +02:00
README.FreeBSD
README.fritzbox FritzBox: Add info on usage with password-only auth (#3158) 2019-12-29 13:40:04 +01:00
README.geolocation.md Updates README.geolocation with OS X instructions 2020-04-27 10:33:04 +02:00
README.grafana
README.historical
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
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
README.md Update password reset links 2019-02-04 10:25:08 +01:00
README.mysql.5.7+.md Typo 2020-03-25 12:08:52 +01: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
README.netbeans.pdf
README.nindex_debug nIndex debug instructions 2020-03-05 15:16:08 +00:00
README.OpenBSD
README.pfsense
README.profiling Profiling dox 2019-09-09 14:04:25 +02:00
README.RADIUS Add ntopng authentication methods documentation 2018-12-05 19:23:30 +01:00
README.raspberry
README.redis
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
README.users Typo 2019-03-27 10:18:57 +01:00
README.vagrant
README.valgrind
README.windows
README.zmq
UserGuide.pages
UserGuide.pdf

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