vnstat-ui

README

========
vnstatui
========

----------------------------------------------------------
Simple web frontend to show some pretty graphs from vnstat
----------------------------------------------------------

:Author: Josh VanderLinden <arch@cloudlery.com>
:Date:   2017-01-03
:Copyright: Public Domain
:Version: 0.8.2
:Manual section: 1
:Manual group: System Tools

Synopsis
========

    vnstatui [-h] [-b BIND] [-p PORT] [-d DATADIR] [-g GRAPHS] [-i IFACES]

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 parameters can be passed to ``vnstatui``:

* ``-b``: 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.
* ``-p``: The port to listen for requests on. Default is port 7000.
* ``-d``: The directory where vnstat keeps its data. Default is
  ``/var/lib/vnstat``.
* ``-g``: 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.

* ``-i``: A list of network interfaces to include graphs for, separated
  by commas. If left empty, all interfaces that vnstat knows about will be
  shown.

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

The ``vnstatui`` service may be configured using the ``/etc/default/vnstatui``
environment file.

Requirements
------------

This utility has few dependencies.

The primary requirements for ``vnstatui`` to function properly are:

* vnstat - http://humdi.net/vnstat/
* systemd - http://www.freedesktop.org/wiki/Software/systemd

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