https://github.com/stefanwalther/speedy
Test, track, monitor and analyze your internet speed.
https://github.com/stefanwalther/speedy
bandwidth docker docker-compose monitor speed-test speedtest
Last synced: 6 days ago
JSON representation
Test, track, monitor and analyze your internet speed.
- Host: GitHub
- URL: https://github.com/stefanwalther/speedy
- Owner: stefanwalther
- License: mit
- Created: 2017-03-24T22:12:11.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-09-13T00:52:48.000Z (about 3 years ago)
- Last Synced: 2025-10-05T20:52:23.582Z (7 days ago)
- Topics: bandwidth, docker, docker-compose, monitor, speed-test, speedtest
- Language: JavaScript
- Homepage:
- Size: 176 KB
- Stars: 41
- Watchers: 0
- Forks: 18
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# speedy
> A very simplistic solution to track, monitor & analyze your internet speed & bandwidth.
## About
Your ISP promises great bandwidth and reliability to you, but you don't fully trust?
Then _speedy_ is the solution for you. Get more insights what you actually get for the money you pay.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
* [Prerequisites](#prerequisites)
* [Run it](#run-it)
* [Configuration](#configuration)
* [Reference Links](#reference-links)
- [Developing](#developing)
- [About](#about)
* [Author](#author)
* [Contributions](#contributions)
* [License](#license)
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
## Features
* Test the download & upload speed of your internet connection
* Save the results for historic analysis
* Ready to use dashboard to review the results
## Installation
### Prerequisites
* Docker (e.g. [Docker for Mac](https://docs.docker.com/docker-for-mac/) or [Docker for Windows](https://docs.docker.com/docker-for-windows/))
### Run it
Fork the repository:
```sh
$ git clone https://github.com/stefanwalther/speedy
```
Then run from the root directory:
```sh
$ docker-compose up -d
```
This will essentially spin up three Docker containers:
* **speedy** - Tiny node.js service to run a speed-test periodically (based on [speedtest-net](https://github.com/ddsol/speedtest.net).
* **InfluxDB** - Time series database to store the results from speedy, based on [InfluxDB](https://github.com/influxdata/influxdb).
* **Grafana** - Pre-Configured [Grafana](https://github.com/grafana/grafana) instance to visualize the results.
Access the resulting dashboard at:
* [http://localhost:3000/dashboard/db/speed-test](http://localhost:3000/dashboard/db/speed-test)
### Configuration
All configurations are stored in [configuration.env](./configuration.env)`configuration.env`.
* **speedy**
- See [here](./docker/speedy/) for more details
- [Docker image:](https://hub.docker.com/r/stefanwalther/speedy/) `stefanwalther/speedy`
* **speedy_infuxdb**
- [Docker image:](https://hub.docker.com/r/stefanwalther/speedy-influxdb/) `stefanwalther/speedy_influxdb`
* **speedy_grafana**
- [Docker image: ](https://hub.docker.com/r/stefanwalther/speedy-grafana/) `stefanwalther/speedy_grafana`
### Reference Links
* Environment variables for InfluxDB: https://docs.influxdata.com/influxdb/v1.2/administration/config#environment-variables
## Developing
Run the development environment:
```sh
$ yarn dc-dev-up
```
The development differs as follows from the example above:
* Containers are build on demand (from the Dockerfiles)
* You can work on the source code in `./docker/speedy/src` and the solution will automatically get updated (using [nodemon](https://nodemon.io/)).
## About
### Author
**Stefan Walther**
* [github/stefanwalther](https://github.com/stefanwalther)
* [twitter/waltherstefan](http://twitter.com/waltherstefan)
* [stefanwalther.io](http://stefanwalther.io)
### Contributions
Contributions are always welcome. Just submit your PR.
### License
MIT