UniFi WAN and client usage reporting – README

UniFi WAN and Client traffic Reporting tool

• currently, versions 4.X.X, 5.X.X and 6.X.X of the UniFi Controller software and UniFi OS Consoles are supported (version 6.5.50 has been confirmed to work)
• please read the Security Notice below before installing this tool!

Requirements

• a web server with PHP and cURL modules installed (confirmed to work on Apache with PHP Version 5.6.32 and cURL 7.29.0 and with PHP 7.2.5 and cURL 7.60.0)
• network connectivity between this web server and the server (and port) where the UniFi controller is running or UniFi OS Console (in case you are seeing errors, please check out this issue)
• clients using this tool should have internet access because several CSS and JS files are loaded from public CDNs.

Installation

Installation of this tool is done by downloading the zip file and unzipping it in your directory of choice, then by following the configuration steps below.

Configuration

• credentials for access to one or more UniFi Controllers are configured in the file named config/config-template.php which should first be copied/renamed to config/config.php
• please refer to the instructions in the config/config-template.php file for further configuration instructions
• you can restrict access to the tool by creating user accounts and passwords, please refer to the instructions in the config/users-template.php file for further details
• after following these steps, you can open the tool in your browser (assuming you installed it in the root folder of your web server as suggested above) by going to this url: http(s)://<server IP address>/<install path>/

Credits

The PHP API client that comes bundled with this tool is based on the work by the following developers:

• domwo: http://community.ubnt.com/t5/UniFi-Wireless/little-php-class-for-unifi-api/m-p/603051
• fbagnol: https://github.com/fbagnol/class.unifi.php

and the API as published by Ubiquiti:

• https://dl.ui.com/unifi/6.2.26/unifi_sh_api

Other included libraries:

• Bootstrap 4 (version 4.3.1) https://getbootstrap.com
• Bootswatch themes (version 4.3.1) https://bootswatch.com
• Font Awesome icons (version 5.11.2) https://fontawesome.com
• jQuery (version 3.4.1) https://jquery.com
• Twig template engine (version 2.12.1) https://twig.symfony.com
• jQuery Datatables https://datatables.net/

Security notice

We highly recommend enabling the user name/password authentication feature by creating a config/users.php based on the included config/users-template.php file. When creating passwords and their SHA512 hashes for entry in the config/users.php file, please make sure to use strong random passwords.

Please refer to the instructions in the config/users-template.php file for further details

It is your own responsibility to implement the necessary additional controls in securing this application and preventing unwanted access.