OPNsense

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

Repository Configuration

Log into the OPNsense Shell as administrator (select option 8).

OPNsense Shell

OPNsense Shell

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:12:amd64/latest/ntop-1.0.txz

The output should look like the below.

ntop Repo Installation

ntop Repository Installation

Plugin Installation

Note

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.

Check for updates

Plugins - 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).

Plugins Installation

ntopng and Redis Plugins Installation

Install plugin os-ntopng-enterprise, then install plugin os-redis (which is a requirement) by clicking on the + symbol.

Warning

The installation log of os-ntopng-enterprise may ask to execute commands to start and enable redis. 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.

Redis Configuration

Redis Configuration

Plugin os-ntopng-enterprise configuration is shown in the following section.

ntopng Configuration

License

Note

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.

ntopng Info

ntopng Info

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.

Service

Going to Services > ntopng Enterprise > Settings > General it is possible to configure the ntopng service. A basic configuration usually includes the below steps:

  1. Enable the service by checking Enable ntopng
  2. Configure a port and select a Certificate to run the GUI in HTTPS-only mode
ntopng Configuration

ntopng Configuration

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

Common Issues

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