Overview

vnstatui

Author: Josh VanderLinden <arch@cloudlery.com>
Date: 2014-05-27
Copyright: Public Domain
Version: r26.3f5840b
Manual section:1
Manual group:System Tools

Synopsis

vnstatui [-h] [-b BIND] [-p PORT]

Description

vnstatui is a simple Web UI for vnstat. It simply presents graphs that are generated by vnstati. You can modify the behavior of vnstatui specify which graphs to display and for which interfaces.

Configuration

The following variables can be set in the vnstatui section of /etc/conf.d/vnstatui.conf:

  • title: The title to show at the top of the page
  • graphs: The types of graphs to show and the order in which they should appear on the page, separated by commas. Valid values include:
    • summary: shows today's traffic vs yesterday, total traffic for the current month, traffic for all time, and a graph showing traffic for each hour of the past 24 hours.
    • hourly: shows traffic for the past 24 hours. This is the same as the hourly graph at the bottom of the summary graph.
    • daily: shows traffic per day for the past few days.
    • monthly: shows traffic per month... you get the idea.
    • top: shows 10 days with the most traffic on record.
  • interfaces: A list of network interfaces to include graphs for, separated by commas. If left empty, all interfaces that vnstat knows about will be shown.
  • bind: The IP address to bind to. For example, 0.0.0.0 will cause vnstatui to serve requests on all interfaces while 127.0.0.1 will cause it to only handle requests on the local machine.
  • port: The port to listen for requests on. Default is port 7000.

Some of these settings may be modified and will take effect immediately without having to restart the vnstatui service. The only ones that do not take effect immediately are bind and port. Modifications to these settings require that you restart the vnstatui service.

Usage

You may run vnstatui via systemd. You may run it once as such:

systemctl start vnstatui

If you wish to run this service at immediately when you boot your computer, use the following command:

systemctl enable vnstatui

Using vnstatui in this fashion is designed to be used with Nginx, as it produces a uWSGI UNIX socket for handling requests by default. You may modify the uWSGI configuration using /etc/conf.d/vnstatui.uwsgi.

If you wish to run vnstatui without relying on uWSGI or Nginx, you may invoke vnstatui from the command line.

Requirements

This utility has few dependencies. It is designed for Arch Linux, but ports to other distributions are more than welcome.

The primary requirements for vnstatui to function properly are:

Be sure that you have installed vnstat correctly and have enabled the vnstat service as well. Otherwise your graphs will probably be pretty sad if they even appear.

You might also be interested in installing some webserver software, such as Nginx or Apache, to proxy requests to vnstatui.

Downloading

Official downloads live on BitBucket.org at http://bitbucket.org/instarch/vnstat-ui/downloads and in Arch Linux's AUR.

Reporting Bugs

If you find a bug or would like to see additional features added to vnstatui, please open an issue on the official issue tracker at http://bitbucket.org/instarch/vnstat-ui/issues