ntop on Docker

This is a Docker image to run a NTOP instance.

This Docker image is based on the offical Alpine image.

Table of Contents

• Install Docker
• Download
• How to use this image
• Next steps
• Important notes
• Update Docker image
• Advanced usage
• Technical details
• Development

Install Docker

To use this image you have to install Docker first.

Download

You can get the trusted build from the Docker Hub registry:

docker pull thbe/ntop

Alternatively, you may build the Docker image from the source code on GitHub.

How to use this image

Environment variables

You can use two environment variables that will be recognized by the start script.

ARG0

The first argument indicates that the NTOPNG should monitor the FRITZ box.

ARG1

The second argument indicates what interface at the FRITZ box should be monitored.

ARG2

The third argument is the password for the FRITZ box.

NTOP_DEBUG

If this environment variable is set, the scripts inside the container will run in debug mode.

Start the NTOP instance

The instance can be started by the start script from GitHub:

wget https://raw.githubusercontent.com/thbe/docker-ntop/master/start_ntop.sh
chmod 755 start_ntop.sh
./start_ntop.sh

If you want to monitor your FRITZ box you have to add the following paramter to the start script:

wget https://raw.githubusercontent.com/thbe/docker-ntop/master/start_ntop.sh
chmod 755 start_ntop.sh
./start_ntop.sh "true" "lan" "secret"

Check server status

You can use the standard Docker commands to examine the status of the NTOPNG instance:

docker logs --tail 1000 --follow --timestamps ntop

Next steps

The next release of this Docker image should have a persistent NTOPNG configuration.

Important notes

The username for the web server is root/password unless you don't change the password with the environment variable as described in the Environment variables section.

Update Docker image

Simply download the trusted build from the Docker Hub registry:

docker pull thbe/ntop

Advanced usage

Build from source code

You can build the image also from source. To do this you have to clone the docker-ntop repository from GitHub:

git clone https://github.com/thbe/docker-ntop.git
cd docker-ntop
docker build --rm --no-cache -t thbe/ntop .

Bash shell inside container

If you need a shell inside the container you can run the following command:

docker exec -ti ntop /bin/sh

Technical details

• Alpine base image
• ntop binary from official Alpine package repository

Development

If you like to add functions or improve this Docker image, feel free to fork the repository and send me a merge request with the modification.