Skip to content

README.md

Latest commit

 

History

History
106 lines (76 loc) · 4.72 KB

README.md

File metadata and controls

106 lines (76 loc) · 4.72 KB

Workflow Status Release CI Codacy Badge codecov

Issues Star Fork

Bandwidth Monitor

A simple shell script designed to run on AsusWRT-Merlin powered routers

Sample Usage by User Screenshot

Try the latest demo version

Table of Contents

Software Features

  • Per-user bandwidth monitoring
  • Usage reports by user/month/year

Technical Features

  • Shell script for data collection
  • Web-based GUI for visualization

Project Structure

react/         # Frontend React app (web GUI)
server/        # Shell scripts and server-side install files
screenshots/   # Example screenshots
scripts/       # Release and utility scripts
README.md      # Project documentation
AGENTS.md      # AI coding agent instructions
LICENSE        # License file

AI Agents: See AGENTS.md for coding conventions and patterns.

Requirements

  • AsusWRT-Merlin powered router (see AsusWRT-Merlin)
  • Hard disk or USB flash drive attached, formatted, and mounted
  • Node.js (for building the web GUI)

Installation instructions:

  • Make sure that you have a harddisk or USB flash drive attached to router and it is formatted and mounted
  • Log into your router via ssh
  • To install application type the following command in ssh terminal:
    • cd /mnt/<mounted_name>/
    • mkdir bwmon
    • cd bwmon
    • wget https://github.com/VREMSoftwareDevelopment/bwmon/releases/download/v3.1.6/bwmon.tar.gz
    • tar -xzvf bwmon.tar.gz
    • chmod +x server/install.sh
    • ./server/install.sh
  • Visit http://<your_router_ip>:<lighttpd_port>/bwmon/index.html to view bandwidth usage statistics

Note:

  • Problem using wget:
    • error getting response: Connection reset by peer - add the following option --no-check-certificate
    • Or download the file from the web-site and copy to the folder

Build Instructions:

  • Install node: see https://nodejs.org
  • Clone the project: git clone https://github.com/VREMSoftwareDevelopment/bwmon.git
  • See detailed build and installation instructions in the react subfolder's README.md file.

Reports

View the latest test and analysis reports:

Contributing

Contributions are welcome! Please open issues or submit pull requests via GitHub. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the terms of the Apache License 2.0.