ntopng for UDM/UDM pro
Distributed under MIT license
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project Notes
Author: Carlos Talbot (@tusc69 on ubnt forums)
The first step is to pull the image from DockerHub. Log into the UDM via ssh and type the following command:
docker pull tusc/ntopng-udm:latest
This will download the latest image to the UDM.
Next, we'll need to create a directory and download some files that will be saved between upgrades. This is a one time operation.
mkdir -p /mnt/data/ntopng/redis
chmod 777 /mnt/data/ntopng/redis
curl -Lo /mnt/data/ntopng/ntopng.conf https://github.com/tusc/ntopng-udm/blob/master/ntopng/ntopng.conf?raw=true
curl -Lo /mnt/data/ntopng/redis.conf https://github.com/tusc/ntopng-udm/blob/master/ntopng/redis.conf?raw=true
Next, we want to create a container with ntopng running on https port 3001 using this image with the above config files.
docker run -d --net=host --restart always \
--name ntopng \
-v /mnt/data/ntopng/redis:/var/lib/redis \
-v /mnt/data/ntopng/ntopng.conf:/etc/ntopng/ntopng.conf \
-v /mnt/data/ntopng/redis.conf:/etc/redis/redis.conf \
docker.io/tusc/ntopng-udm:latest
Open a web browser page to your UDM's ip address with port 3001 at the end using https. For example: https://192.168.1.1:3001
If you have to reboot the UDM you'll have to restart the container. You can do so by typing the following:
docker start ntopng
Fortunately you can also take advantage of boostchicken's great tool to automatically start a Docker container after a reboot: https://github.com/boostchicken/udm-utilities/tree/master/on-boot-script
If you're interested in compiling your own version I have a Dockerfile available here that compiles ntopng from source: https://github.com/tusc/ntopng-udm/blob/master/source/Dockerfile
Customize settings
The default instance will listen on the LAN interface (br0). You can edit the file /mnt/data/ntopng/ntopng.conf on the UDM to change the settings. The default is -e (daemon mode), -i=br0 (LAN), n=1 ( Decode DNS responses and resolve all numeric IPs ) and -W3001 (enable HTTPS port)
NOTE If you comment out the -i interface and let ntopng startup listening to all interfaces you will have to wait up to 30 seconds for all interfaces to register. This will also consume additional CPU and memory resources so be careful with this option.
You can also customize the settings for the redis database if you want to eliminates database saves to storage. That file is located at /mnt/data/ntopng/redis.conf
Uninstalling
To remove the docker instance and image you'll need to type the following at the UDM ssh prompt:
docker stop ntopng
docker rm ntopng
docker rmi docker.io/tusc/ntopng-udm (or "docker rmi ntopng-image" if you installed the first release)
Upgrades
Whenever there is a new version of ntopng you can easily perform an upgrade by doing the following commands:
docker stop ntopng
docker rm ntopng
docker pull tusc/ntopng-udm:latest
docker run -d --net=host --restart always \
--name ntopng \
-v /mnt/data/ntopng/redis:/var/lib/redis \
-v /mnt/data/ntopng/ntopng.conf:/etc/ntopng/ntopng.conf \
-v /mnt/data/ntopng/redis.conf:/etc/redis/redis.conf \
docker.io/tusc/ntopng-udm:latest
Console Lockout
If for whatever reason you find yourself locked out of the ntopng login prompt you can follow the steps on this page for resetting the password: https://www.ntop.org/guides/ntopng/faq.html#cannot-login-into-the-gui
You have to connect to the containter in order to run the redis commands as reference in the FAQ. Do so by typing the following below. You can type "exit" to get out of the container when you're done.
docker exec -it ntopng bash
