speed-tester/README.md

1.5 KiB

Internet Speed tester

This project provides a comprehensive internet speed monitoring solution by:

  • Testing: Regularly measures download speed, upload speed, latency (ping), and packet loss using the speedtest-go library.
  • Data Storage: Saves the collected data in a chosen database for historical analysis.
  • Visualization: Generates graphs to visualize the internet performance over time, allowing you to identify periods of slowdowns or instability.
  • Web Interface: Integrates with a web interface to display the generated graphs in a browser for easy access and monitoring.

Usage

  1. Go to the releases tab
  2. download the latest version
  3. execute the binary
  4. wait for data (like 5min)
  5. open http://localhost:7331 to view graphs

Contributing

We welcome contributions from the community! If you find any issues or have improvements to suggest, feel free to open an issue.

To get started with development or contribute to the project, follow these steps:

  1. Clone the Repository:
    https

    git clone https://gitea.zokki.net/zokki/speed-tester.git
    


    ssh

    git clone gitea@zokki.net:zokki/speed-tester.git
    
  2. Install Dependencies:

    cd speed-tester
    go mod download
    
  3. Run the Development Server:

    make live
    

    This will start a local development server. Open your browser and navigate to http://localhost:7331 to view the website.

License

AGPL-3.0 © Tim-Niclas Oelschläger