e7db/speedtest repository overview

⁠Speed Test

A self-hosted, lightweight speed test implemented in JavaScript, and based on Web Workers⁠ and XMLHttpRequest⁠.

• Speed Test⁠
  • Demo⁠
  • Usage⁠
    • Compatibility⁠
    • Features⁠
    • Requirements⁠
    • Configuration⁠
      • Endpoints configuration⁠
    • Docker⁠
      • Run the Speed Test container⁠
      • Store the results permanently⁠
      • Use a custom configuration⁠
    • Self-hosted server⁠
  • Development⁠
    • Prerequisites⁠
    • Setup the repository⁠
    • Issues⁠
  • Support the project⁠
  • License⁠

⁠Demo

A demo is available here, running on a Digital Ocean server based on Amsterdam:

• stable: http://134.209.196.181:8080⁠
• develop: http://134.209.196.181:8081⁠

⁠Usage

⁠Compatibility

⁠Features

• IP Address (with ISP) detection
• Latency and jitter tests
• Download and upload bandwidth tests

⁠Requirements

• Some decent server CPU
• Using HTTPS is highly discouraged, adding an heavy packet size and computing overhead
• Using server compression is also discouraged, adding a computing overhead

⁠Configuration

You can configure the speed test server following your needs. Find below the list of configurable options through the file config.json available at the root level of the server.
The key corresponds to the JSON path where to affect the value. For example, setting the value 2000 for the key download.delay corresponds to the following JSON:

{
  "download": {
    "delay": 2000
  }
}

List of configurable options:

⁠Endpoints configuration

{
  "endpoints": [
    {
      "label": "FR",
      "uri": "http://speedtest-fr.localhost:5080"
    },
    {
      "label": "FR (secured)",
      "uri": "https://speedtest-fr.localhost:5443"
    },
    {
      "label": "NL",
      "uri": "http://speedtest-nl.localhost:5080"
    },
    {
      "label": "UK",
      "uri": "http://speedtest-uk.localhost:5080"
    },
    {
      "label": "US",
      "uri": "http://speedtest-us.localhost:5080"
    }
  ]
}

⁠Docker

⁠Run the Speed Test container

docker run --name speedtest -d -p 80:80 e7db/speedtest

⁠Store the results permanently

To store results permanently, you need a volume:

docker volume create speedtest_results
docker run --name speedtest -d -p 80:80 -v speedtest_results:/app/results e7db/speedtest

Note: Results are never cleaned automatically, used space will grow over time.

⁠Use a custom configuration

To use a custom configuration through the config.json file, mount it through a read-only volume:

docker run --name speedtest -d -p 80:80 -v /path/to/config.json:/app/web/config.json:ro e7db/speedtest

⁠Self-hosted server

Having cloned this repository and moved into the directory, issue the following commands:

npm run setup
npm run build
npm run start

⁠Development

⁠Prerequisites

• GraphicsMagick: http://www.graphicsmagick.org/download.html⁠
• GhostScript: https://www.ghostscript.com/download.html⁠
• ImageMagick: https://imagemagick.org/script/download.php⁠
• Install fonts from assets/fonts
• NodeJS + NPM

⁠Setup the repository

To setup, build and run the project for development, issue the following commands:

npm run setup:dev
npm run build:dev
npm run start:dev

⁠Issues

If you encounter a problem with the Speed Test, please check if an existing issue⁠ adresses it and join the discussion. If not, feel free to create a new issue.

⁠Support the project

You want to support the project? A speed test requires a server with high bandwidth. With Patreon, Paypal or cryprocurrencies, you can help me cover the fees!

1D4fa6WDVNmKmwRJzTKDohYmHB9UzMsVVL
0x57f1afbC888d6954F954B0960524E4aa5Fa188af

⁠License

MIT License

Copyright (c) 2017-2019 Michaël "e7d" Ferrand

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.