Skip to content

Latest commit

 

History

History
188 lines (135 loc) · 7 KB

README.md

File metadata and controls

188 lines (135 loc) · 7 KB

GitHub license FOSSA Status DockerPulls DockerPulls GitHub forks GitHub stars GitHub issues

fboaventura/dckr-mrtg

Docker instance to run MRTG - The Multi Router Traffic Grapher

Versioning

Until version 2.2.0, I used NGINX, and all the HTML files were statically built by MRTG.
From 2.3.0 onwards, I've implemented the support for rrdtool and replaced NGINX with LIGHTTPD, since I needed the support to run CGI scripts.

From version 2.3.0 the WEBDIR went from /usr/share/nginx/html to /mrtg/html. So please, check all your configuration files if you are getting some path-related error on the graphics.
It's also possible to pass the environment variable WEBDIR on the docker-compose.yml or command line (-e).

How to use

This instance is published at Docker Hub, and all you need to run is:

$ docker run -d -p 8880:80 -e "HOSTS='public:localhost:2,community:ipaddress'" fboaventura/dckr-mrtg:latest

You can, of course, pass some custom values to make it more prone to your usage. The variables and their defaults are:

Environment

ENV TZ "UTC"
ENV HOSTS "community:host[:version[:port]]"
ENV WEBDIR "/mrtg/html"
ENV PATHPREFIX ""
ENV USERID "100"
ENV GROUPID "101"
ENV REGENERATEHTML "yes"
ENV INDEXMAKEROPTIONS ""

The variable TZ will configure the timezone used by the OS and MRTG to show dates and times.

The variable HOSTS is where you may set the hosts that MRTG will monitor. The format to be used is community:host[:version[:port]],community:host[:version:[port]],...

Where:

  • community: is the SNMP community with read access
  • host: is the IP address or hostname (if Docker can resolve it)
  • version: can be 1 or 2 for SNMP 1 or 2c. If left empty it will assume 2c.
  • port: can be any custom port. There is one point of attention, if the port is needed, then the version must be set.

The variable PATHPREFIX (default: empty string) is the path passed to indexmaker to prefix URLs to rrdviewer or any images. The format must NOT include a trailing slash. For example, "/mrtg" Used with a reverse proxy, this allows mrtg to exist at a subpath rather than the root.

The variable USERID (default: 100) defines the userid for the lighttpd user. The files in the html directory will be owned by this user. Normally this value should be set to 1000 (or above), depending on your needs for mapped volumes.

The variable GROUPID (default: 101) defines the groupid for the lighttpd user. Normally this value should be set to the same value as USERID, but other values can be used depending on your needs.

The variable REGENERATEHTML (default: "yes") determines if the index.html file will be regenerated at container restart. The original index.html will be renamed index.old (overwriting any earlier file with that name). You should set this value to anything other than "yes" if you have any custom changes to index.html that you do not want overwritten at container restart.

The variable INDEXMAKEROPTIONS (default: empty string) allows you to add any extra options passed to indexmaker, e.g. --nolegend.

Persistence

If you plan on keeping this instance running as your MRTG service, you may pass volumes to be used to save the information produced by MRTG. To achieve this:

From the command line:

$ mkdir html conf.d
$ docker run -d -p 8880:80 -e "HOSTS='public:localhost,community:ipaddress'" -v `pwd`/html:/mrtg/html -v `pwd`/conf.d:/etc/mrtg/conf.d fboaventura/dckr-mrtg:latest

docker-compose

version: "3.5"

services:
  mrtg:
    image: fboaventura/dckr-mrtg:latest
    hostname: mrtg
    restart: always
    ports:
      - "8880:80"
    volumes:
      - "./conf.d:/etc/mrtg/conf.d"
      - "./html:/mrtg/html"
      - "/etc/localtime:/etc/localtime:ro"
      - "/etc/timezone:/etc/timezone:ro"
    environment:
        TZ: "Brazil/East"
        HOSTS: "public:192.168.0.123"
        WEBDIR: "/mrtg/html"
        USERID: 1000
        GROUPID: 1000
    tmpfs:
      - "/run"

Once the instance is running, all you have to do is open a web browser and point it to http://localhost:8880

ChangeLog

v2.5.0 - 2023.01.15

  • Added the ability to set USERID and GROUPID for volume mapping scenarios (@TweakM)
  • Added the option to not regenerate the index.html file, applicable when custom/manual changes to this file have been made (@TweakM)
  • Added the ability to specify additional options for indexmaker (allowing more customizations) (@TweakM)
  • Updated documentation
  • Fixed typo's

v2.4.0 - 2022.08.26

  • Enabled multi-arch building and images at Docker Hub
  • Released the Docker latest tag to follow the releases
  • Bumped Alpine version

v2.3.2 - 2022.08.25

  • Added /etc/localtime to docker example (@michaelkrieger)
  • Added the option to allow use of Path Prefix (@michaelkrieger)
  • Updated Alpine version

v2.3.1 - 2021.09.03

  • Fixed README.md example settings for HTML folder (#4)
  • Fixed the lighttpd daemon flag
  • Added support for a custom port

v2.3.0 - 2021.06

  • Updated Alpine version
  • Added support for SNMP version
  • Added support for rrdtool
  • Replaced NGINX by LIGHTTPD
  • Changed the HTML folder from /usr/share/nginx/html to /mrtg/html
  • Fixed latest tag to v2.2.0 to prevent compatibility breaking
  • Changed the versioning schema to support only tagged versions

v2.2.0 - 2020.04

  • Updated Alpine version
  • Updated docker-compose.yml to version 3.5
  • Fixed the fallback for the empty HOST

v2.1.1 - 2019.10

  • Updated Alpine and MRTG Versions

v1.3 - 2019.08

  • Updated Alpine version

v1.2 - 2019.05

  • Updated Alpine version

v1.1 - 2018.10

  • 2018.10 - Updated MRTG and Alpine versions

v1.0.0 - 2017.08

  • First version

License

FOSSA Status