{"id":34298272,"url":"https://github.com/vremsoftwaredevelopment/bwmon","last_synced_at":"2026-03-14T20:36:33.701Z","repository":{"id":12766712,"uuid":"15440087","full_name":"VREMSoftwareDevelopment/bwmon","owner":"VREMSoftwareDevelopment","description":"Bandwidth Monitor Usage - AsusWRT-Merlin","archived":false,"fork":false,"pushed_at":"2025-12-15T18:14:23.000Z","size":30662,"stargazers_count":37,"open_issues_count":0,"forks_count":9,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-12-16T02:08:33.416Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VREMSoftwareDevelopment.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2013-12-25T20:15:02.000Z","updated_at":"2025-12-15T18:08:43.000Z","dependencies_parsed_at":"2023-02-12T17:15:46.894Z","dependency_job_id":"1e026916-6ca5-4b73-b2f3-f306d83e8ec6","html_url":"https://github.com/VREMSoftwareDevelopment/bwmon","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/VREMSoftwareDevelopment/bwmon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VREMSoftwareDevelopment%2Fbwmon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VREMSoftwareDevelopment%2Fbwmon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VREMSoftwareDevelopment%2Fbwmon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VREMSoftwareDevelopment%2Fbwmon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VREMSoftwareDevelopment","download_url":"https://codeload.github.com/VREMSoftwareDevelopment/bwmon/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VREMSoftwareDevelopment%2Fbwmon/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27777521,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-17T02:00:08.291Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-12-17T05:05:18.858Z","updated_at":"2026-03-14T20:36:33.695Z","avatar_url":"https://github.com/VREMSoftwareDevelopment.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Workflow Status](https://github.com/VREMSoftwareDevelopment/bwmon/workflows/CI/badge.svg)](https://github.com/VREMSoftwareDevelopment/bwmon/actions?query=workflow%3A%22CI%22)\n[![Release CI](https://github.com/VREMSoftwareDevelopment/bwmon/workflows/Release-CI/badge.svg)](https://github.com/VREMSoftwareDevelopment/bwmon/actions?query=workflow%3A%22Release-CI%22)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/4bc1d97a37564d63acf4e9e02dd06615)](https://app.codacy.com/gh/VREMSoftwareDevelopment/bwmon?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=VREMSoftwareDevelopment/bwmon\u0026utm_campaign=Badge_Grade)\n[![codecov](https://codecov.io/gh/VREMSoftwareDevelopment/bwmon/branch/main/graph/badge.svg?token=qoDvVAvNaw)](https://codecov.io/gh/VREMSoftwareDevelopment/bwmon)\n\n[![Issues](https://img.shields.io/github/issues/VREMSoftwareDevelopment/bwmon.svg)](https://github.com/VREMSoftwareDevelopment/bwmon/issues)\n[![Star](https://img.shields.io/github/stars/VREMSoftwareDevelopment/bwmon.svg)](https://github.com/VREMSoftwareDevelopment/bwmon/stargazers)\n[![Fork](https://img.shields.io/github/forks/VREMSoftwareDevelopment/bwmon.svg)](https://github.com/VREMSoftwareDevelopment/bwmon/network)\n\n# Bandwidth Monitor\n\nA simple shell script designed to run on [AsusWRT-Merlin](https://www.asuswrt-merlin.net/) powered routers\n\n![Sample Usage by User Screenshot](https://github.com/VREMSoftwareDevelopment/bwmon/raw/main/screenshots/UsageByUserData.jpg 'Sample Usage by User Screenshot')\n\n[Try the latest demo version](https://vremsoftwaredevelopment.github.io/bwmon)\n\n---\n\n## Table of Contents\n\n-   [Bandwidth Monitor](#bandwidth-monitor)\n-   [Table of Contents](#table-of-contents)\n-   [Software Features](#software-features)\n-   [Technical Features](#technical-features)\n-   [Project Structure](#project-structure)\n-   [Requirements](#requirements)\n-   [Installation instructions](#installation-instructions)\n-   [Note](#note)\n-   [Build Instructions](#build-instructions)\n-   [Contributing](#contributing)\n-   [License](#license)\n\n## Software Features\n\n-   Per-user bandwidth monitoring\n-   Usage reports by user/month/year\n\n## Technical Features\n\n-   Shell script for data collection\n-   Web-based GUI for visualization\n\n## Project Structure\n\n```\nreact/         # Frontend React app (web GUI)\nserver/        # Shell scripts and server-side install files\nscreenshots/   # Example screenshots\nscripts/       # Release and utility scripts\nREADME.md      # Project documentation\nAGENTS.md      # AI coding agent instructions\nLICENSE        # License file\n```\n\n\u003e **AI Agents**: See [AGENTS.md](AGENTS.md) for coding conventions and patterns.\n\n## Requirements\n\n-   AsusWRT-Merlin powered router (see [AsusWRT-Merlin](https://www.asuswrt-merlin.net/))\n-   Hard disk or USB flash drive attached, formatted, and mounted\n-   Node.js (for building the web GUI)\n\n## Installation instructions:\n\n-   Make sure that you have a harddisk or USB flash drive attached to router and it is formatted and mounted\n-   Log into your router via _ssh_\n-   To install application type the following command in _ssh_ terminal:\n    -   `cd /mnt/\u003cmounted_name\u003e/`\n    -   `mkdir bwmon`\n    -   `cd bwmon`\n    -   `wget https://github.com/VREMSoftwareDevelopment/bwmon/releases/download/v3.1.6/bwmon.tar.gz`\n    -   `tar -xzvf bwmon.tar.gz`\n    -   `chmod +x server/install.sh`\n    -   `./server/install.sh`\n-   Visit `http://\u003cyour_router_ip\u003e:\u003clighttpd_port\u003e/bwmon/index.html` to view bandwidth usage statistics\n\n## Note:\n\n-   Problem using `wget`:\n    -   _error getting response: Connection reset by peer_ - add the following option `--no-check-certificate`\n    -   Or download the file from the web-site and copy to the folder\n\n## Build Instructions:\n\n-   Install node: see [https://nodejs.org](https://nodejs.org)\n-   Clone the project: `git clone https://github.com/VREMSoftwareDevelopment/bwmon.git`\n-   See detailed build and installation instructions in the `react` subfolder's [README.md](react/README.md) file.\n\n## Reports\n\nView the latest test and analysis reports:\n\n-   [Coverage Report](https://vremsoftwaredevelopment.github.io/bwmon/reports/coverage/lcov-report/index.html)\n-   [Mutation Report](https://vremsoftwaredevelopment.github.io/bwmon/reports/mutation/mutation.html)\n-   [Playwright Report](https://vremsoftwaredevelopment.github.io/bwmon/reports/playwright/html/index.html)\n-   [Duplication Report](https://vremsoftwaredevelopment.github.io/bwmon/reports/duplication/index.html)\n-   [Bundle Analysis (Visualizer)](https://vremsoftwaredevelopment.github.io/bwmon/reports/visualizer/stats.html)\n\n## Contributing\n\nContributions 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.\n\n## License\n\nThis project is licensed under the terms of the [Apache License 2.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvremsoftwaredevelopment%2Fbwmon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvremsoftwaredevelopment%2Fbwmon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvremsoftwaredevelopment%2Fbwmon/lists"}