ntopng/doc
GabrieleDeri bc89aaaa1e
Some checks are pending
Build / build (push) Waiting to run
CIFuzz / Fuzzing (address) (push) Waiting to run
CIFuzz / Fuzzing (undefined) (push) Waiting to run
CodeQL / Analyze-1 (push) Waiting to run
CodeQL / Analyze (push) Waiting to run
Added AI dashboard documentation (#11098)
* updated MCP tools documentaiton

* Added ai dashboard documentation
2026-10-18 18:40:05 +02:00
..
developers Asset tags TTL: keep application/risk tags alive under long-lived flows (#11083) 2026-10-16 10:28:11 +02:00
img Add files via upload 2025-02-13 11:37:28 +01:00
nedge/src Update doc 2026-09-03 15:03:56 +02:00
src Added AI dashboard documentation (#11098) 2026-10-18 18:40:05 +02:00
doxygen.conf.in
mainpage.dox Update URLs 2025-07-09 15:58:30 +02:00
README.active_scan.md Vulnerability Scan converted to Active Scan (#10774) 2026-08-14 17:43:43 +02:00
README.backup Add readme (configuration backup) 2024-01-31 16:29:13 +01:00
README.beta_features Update README.beta_features 2021-11-25 09:48:48 +01:00
README.beta_features_anomalies.md
README.cento
README.charts
README.clickhouse.md Revise TTL management instructions in README 2026-05-11 21:49:11 +02:00
README.clickhouse_schema.md Add Requested Server Name / SNI column (move the name from the json to the native column) 2026-09-14 17:03:47 +02:00
README.compilation Added optinal package 2026-05-22 14:11:07 +02:00
README.crash.md Update crash README 2021-01-20 10:44:08 +01:00
README.CSRF.md
README.custom_scripts
README.db_view.md Create README.db_view.md 2024-07-11 17:20:09 +02:00
README.doc.md Updated README.doc.md with instructions in case py env generates permission problems 2026-05-12 08:20:13 +00:00
README.docker_openstack Update URLs 2025-07-09 15:58:30 +02:00
README.doxygen
README.eBPF.md
README.elasticsearch
README.FlowHashEntry_FSM.dot
README.fritzbox
README.frontend.md Moved frontend code to pro (#10646) 2026-07-24 14:15:40 +02:00
README.fuzz.md Create README.fuzz.md 2023-05-22 19:06:28 +02:00
README.geolocation.md Minor update 2024-07-03 17:12:26 +02:00
README.git_hooks.md Update README.git_hooks.md 2021-12-27 16:25:05 +01:00
README.grafana
README.gui_testing.md README for GUI testing 2024-02-18 21:46:23 +01:00
README.HostHashEntry_FSM.dot
README.HTTP_AUTHENTICATOR
README.influxdb.md Update README.influxdb.md 2023-04-19 09:13:22 +02:00
README.inline Fix links 2025-09-19 09:02:51 +02:00
README.inline_http_configuration
README.IPv6
README.kibana.md Reworked Kibana documentation 2022-06-20 19:38:09 +02:00
README.ldap.md Update README.ldap.md 2025-05-29 09:28:46 +02:00
README.leaks_detector.md Update README.leaks_detector.md 2021-08-04 09:49:51 +02:00
README.logstash
README.lua_api.md Removed reference 2026-03-15 12:04:10 +01:00
README.lua_flow_api.md Further Lua API documentation 2026-03-15 12:02:07 +01:00
README.lua_host_api.md Further Lua API documentation 2026-03-15 12:02:07 +01:00
README.lua_interface_api.md Removed site id from old code and added support to networks in site add/edit (#10322) 2026-05-14 10:45:36 +00:00
README.lua_network_api.md Further Lua API documentation 2026-03-15 12:02:07 +01:00
README.lua_ntop_api.md Made Passkey creation available only on HTTPS (#11067) 2026-10-08 11:52:28 +02:00
README.md Update README with valkey installation instructions 2026-08-17 22:02:42 +02:00
README.merge_git_branch.md Minor changes to merge readme and script name 2021-12-28 16:29:34 +01:00
README.Mikrotik.md added mikrotik port mirror README 2024-08-10 19:12:49 +02:00
README.nagios.md
README.nedge_http_configuration
README.OpenBSD Remove mysql/maria dependencies. Update docs. 2025-06-09 16:50:09 +02:00
README.profiling
README.quotas.md Add technical documentation for quotas 2023-05-05 16:44:27 +02:00
README.raspberry
README.redis
README.run_two_instances Readme for running multiple ntopng instances 2020-11-10 22:57:45 +01:00
README.sanitizer Add sanitizer instructions and common errors 2024-02-08 17:48:47 +01:00
README.scripts Removed plugin word and updated docs 2022-02-11 12:07:23 +01:00
README.security.md
README.slack
README.snmp
README.SSL.md Update README.SSL.md 2025-06-19 11:24:07 +02:00
README.systemd.md
README.testing.md Rewoked testing documentation 2024-11-28 11:36:44 +01:00
README.unit_rules_and_conventions.md Update README.unit_rules_and_conventions.md 2021-08-02 10:39:50 +02:00
README.users
README.vagrant
README.valgrind
README.vyos.md Typos 2020-11-18 18:11:21 +01:00
README.windows
README.zmq Update URLs 2025-07-09 15:58:30 +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

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 with -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 ...

In case you save timseries in InfluxDB, make sure you use a different DB per instance in order not to mix data across instances.

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.

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.

Rocky Linux and redis-server

In the latest RockyLinux version there is no redis-server package to install. You can use as drop-in replacement valkey that you can install as follows:

sudo dnf install -y valkey
sudo systemctl enable --now valkey

Debugging ntopng

handle SIGPIPE nostop noprint pass