ntopng can be installed on OPNsense as plugin using the Web interface (recommended) or using the command line. In both cases the ntop repository for FreeBSD should be configured as described at https://packages.ntop.org/FreeBSD/.
ntopng will create files on your OPNsense device to store traffic data. If you have a device with limited disk space, please configure ntopng to store only a few timeseries to disk othewise you might fill all the available disk space and make your system unstable.
Log into the OPNsense Shell as administrator (select option 8).
And install the repository using the command provided at https://packages.ntop.org/FreeBSD/ (you can cut&paste the command below).
pkg add https://packages.ntop.org/FreeBSD/FreeBSD:13:amd64/latest/ntop-1.0.pkg
On older OPNsense versions the package prefix is .txz so the command will be pkg add https://packages.ntop.org/FreeBSD/FreeBSD:12:amd64/latest/ntop-1.0.txz
The output should look like the below.
Plugins installation in OPNsense requires you to log in as administrator.
Point the browser to the OPNsense management page, go to the System > Firmware > Plugins page, and click on the Check for updates.
The os-ntopng-enterprise plugin should appear in the list, in addition to the built-in os-ntopng plugin, which does not provide enhanced and Enterprise features (please make sure you remove it in case the latter is already installed).
Install plugin os-ntopng-enterprise, then install plugin os-redis (which is a requirement) by clicking on the + symbol.
The installation log of os-ntopng-enterprise may ask to execute commands to start and enable
Ignore those commands as
redis will be managed from its plugin os-redis.
To configure the os-redis plugin, go to Services > Redis, select Enable Redis and click Apply.
Plugin os-ntopng-enterprise configuration is shown in the following section.
ntopng Community Edition is free of charge and does not require a license.
To run a licensed version of ntopng, a license key needs to be generated. To generate a license key, ntopng Version and System ID are required. To obtain this information go to Services > ntopng Enterprise > Settings > License.
The link at the bottom of the page can be followed to generate the license key.
The license can be installed through the same page by pasting it in the License Key box and saving the configuration. The service should be restarted in the General page.
Please note that ntopng runs by default as Enterprise in demo mode. In order to run ntopng in Community mode please check the Community Mode flag, save the configuration and restart the service through the General page.
Going to Services > ntopng Enterprise > Settings > General it is possible to configure the ntopng service. A basic configuration usually includes the below steps:
- Enable the service by checking Enable ntopng
- Configure a port and select a Certificate to run the GUI in HTTPS-only mode
Save the configuration and run the service. A link at the bottom of the page will redirect you to the ntopng Web GUI.
By default ntopng analyses traffic from all the interfaces. Select the advanced mode to select a specific interface. Alternatively it is possible to use the Connect to nProbe switch to collect traffic information from a local nProbe instance (please take a look at the os-nprobe nProbe plugin guide).
A common issue on FreeBSD which is preventing ntopng from running and even showing Version and License information under Settings > License, is a corrupted Redis database. In order to quickly fix this it is required to remove the database files under /var/db/redis/*.rdb and restart the service (or reboot the machine).
Some users experienced issues adding the ntop repository in OPNsense as shown in the trace below. This seems to be due to an issue with the ACME plugin. Manually importing LE root and intermediate CA chain seems to fix this issue. Please read https://forum.opnsense.org/index.php?topic=25178.0 for more info.
pkg add https://packages.ntop.org/FreeBSD/FreeBSD:12:amd64/latest/ntop-1.0.txz Certificate verification failed for /O=Digital Signature Trust Co./CN=DST Root CA X3 2275989975040:error:1416F086:SSL routines:tls_process_server_certificate:certificate verify failed:/usr/src/crypto/openssl/ssl/statem/statem_clnt.c:1915: pkg: https://packages.ntop.org/FreeBSD/FreeBSD:12:amd64/latest/ntop-1.0.txz: Authentication error