A self-hosted, lightweight speed test implemented in JavaScript, and based on Web Workers and XMLHttpRequest.
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
| Chrome | Edge | Firefox | Opera | Safari |
|---|---|---|---|---|
| 43 | * | 48.0 | 12.10 | 6.0 |
- IP Address (with ISP) detection
- Latency and jitter tests
- Download and upload bandwidth tests
- 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
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:
| Key | Description | Default value | Possible values |
|---|---|---|---|
| analytics.trackingId | The Google Analytics tracking ID to use on the speed test. | "UA-XXXXXXXX-Y" or empty. | |
| ignoreErrors | Ignore the errors yielded by upload/download requests. If false, the test will be aborted at the first error. | true | true or false. |
| endpoints | The available endpoints list. | See Endpoints configuration below. | |
| endpoint.xhr | The endpoint to request for XHR. | current location | Any http:// or https:// endpoint exposing this speed test. |
| endpoint.websocket | The endpoint to request for WebSocket. | current location | Any ws:// or wss:// endpoint exposing this speed test. |
| ip.path | The path of the IP test on the XHR endpoint. | ip | |
| latency.path | The path of the latency test on the WebSocket endpoint. | ping | |
| latency.count | The count of latency requests to emit during the latency test. | null | Any positive integer. |
| latency.duration | The duration in milliseconds of the latency test. | 5000 | Any positive integer. |
| latency.gracetime | The duration in milliseconds at start of the latency test during which results are ignored. Used for test warm-up. | 1000 | Any positive integer. |
| download.path | The path of the download test on the XHR endpoint. | download | |
| download.streams | The number of concurrent streams to use during the download test. | 6 | Any positive integer. |
| download.delay | The delay in milliseconds between the first request of each stream. | 200 | Any positive integer. |
| download.duration | The duration in milliseconds of the download test. | 10000 | Any positive integer. |
| download.gracetime | The duration in milliseconds at start of the download test during which results are ignored. Used for test warm-up. | 2000 | Any positive integer. |
| download.size | The size in bytes downloaded on each download request. | 8388608 (8M) | Any positive integer. |
| download.adjustSize | Auto adjust download packets size, depending on bandwidth. | true | |
| download.minSize | The minimum size in bytes downloaded on each download request, to avoid excessively small requests. | 1048576 (1M) | Any positive integer. |
| download.maxSize | The maximum size in bytes downloaded on each download request, to avoid excessively huge requests. | 104857600 (100M) | Any positive integer. |
| upload.path | The path of the upload test on the XHR endpoint. | upload | |
| upload.streams | The number of concurrent streams to use during the upload test. | 6 | Any positive integer. |
| upload.delay | The delay in milliseconds between the first request of each stream. | 200 | Any positive integer. |
| upload.duration | The duration in milliseconds of the upload test. | 10000 | Any positive integer. |
| upload.gracetime | The duration in milliseconds at start of the upload test during which results are ignored. Used for test warm-up. | 2000 | Any positive integer. |
| upload.size | The size in bytes uploaded on each upload request. | 20971520 (2M) | Any positive integer. |
| upload.adjustSize | Auto adjust upload packets size, depending on bandwidth. | true | |
| upload.minSize | The minimum size in bytes uploaded on each upload request, to avoid excessively small requests. | 262144 (256K) | Any positive integer. |
| upload.maxSize | The maximum size in bytes uploaded on each upload request, to avoid excessively huge requests. | 20971520 (20M) | Any positive integer. |
| result.path | The path of the save result request on the XHR endpoint. | save |
{
"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 --name speedtest -d -p 80:80 e7db/speedtestTo 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/speedtestNote: Results are never cleaned automatically, used space will grow over time.
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/speedtestHaving cloned this repository and moved into the directory, issue the following commands:
npm run setup
npm run build
npm run start- 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 14 + NPM
To setup, build and run the project for development, issue the following commands:
npm run setup:dev
npm run build:dev
npm run start:devIf 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.
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
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.