bobmel/nedi repository overview

⁠hub.docker.com/r/bobmel/nedi

⁠Introduction

Dockerfile to build a Nedi⁠ container image for Wandboard Quad (armhf architecture). It probably works for other ARM-based computers like the Raspberry Pi but that's not tested.

• NeDi discovers your network devices and tracks connected end-nodes. Some of its features are:
  • Topology awareness and network maps
  • Traffic graphing
  • Uptime, BGP peer and interface status monitoring
  • Extensive reporting ranging from devices, modules and interfaces
• This container uses a customized Nginx with Php-FPM⁠ which includes s6 overlay⁠ enabled for PID 1 Init capabilities, zabbix-agent⁠ for individual container monitoring, Cron also installed along with other tools (bash,curl, less, logrotate, mariadb-client, nano, vim) for easier management. It also supports sending to external SMTP servers..

Changelog⁠

⁠Authors

• Bob Melander⁠

⁠Table of Contents

• Introduction⁠
  • Changelog⁠
• Prerequisites⁠
• Installation⁠
• Quick Start⁠
• Configuration⁠
  • Database⁠
  • Data Volumes⁠
  • Environment Variables⁠
  • Networking⁠
• Maintenance⁠
  • Shell Access⁠
  • References⁠

⁠Prerequisites

This image assumes that you are using a reverse proxy such as jwilder/nginx-proxy⁠ and optionally the Let's Encrypt Proxy Companion @ https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion⁠ in order to serve your pages. However, it will run just fine on it's own if you map appropriate ports.

⁠Installation

Builds of the image are available on Registry⁠ and is the recommended method of installation.

docker pull hub.docker.com/bobmel/nedi:(imagetag)

The following image tags are available:

• latest - Nedi 1.8C with PHP 7.3.x w/Alpine edge

⁠Quick Start

• The quickest way to get started is using docker-compose⁠. See the examples folder for a working docker-compose.yml⁠ that can be modified for development or production use.

• Set various environment variables⁠ to understand the capabilities of this image.

• Map persistent storage⁠ for access to configuration and data files for backup.

⁠Configuration

⁠Data-Volumes

When the container starts up for the first time it downloads and installs Nedi in /data/nedi. Nedi's configuration file, /etc/nedi.conf, is a symlink to /data/nedi/nedi.conf. Nginx's default server config /etc/nginx/conf.d/default.conf is a symlink to Nedi's web server configuration file /etc/nginx/conf.d/default.conf/default_nedi.conf.

The following directory is used for configuration and can be mapped for persistent storage.

Additional directories as specified in the Base image⁠, the Nginx Base⁠, and Nginx with Php-FPM⁠ can also be mapped to the host for persistent storage.

⁠Database

A separately running MariaDB instance is required. The database to use is set using environment variables. See the Environment Variables⁠ section for details.

⁠Environment Variables

Below is a list of available options that can be used to customize your installation.

Addtional options can be found the Base image⁠, the Nginx Base⁠, and Nginx with Php-FPM⁠.

⁠Networking

The following ports are exposed.

⁠Maintenance

⁠Shell Access

For debugging and maintenance purposes you may want access the containers shell.

docker exec -it (whatever your container name is, e.g., nedi) bash

⁠References

• https://www.nedi.ch⁠
• https://www.nginx.org⁠
• http://www.php.org⁠