2019-09-25 06:27:55 +00:00
![LibreSpeed Logo ](https://github.com/librespeed/speedtest/blob/master/.logo/logo3.png?raw=true )
2018-10-28 08:48:18 +00:00
2019-09-25 06:27:55 +00:00
# LibreSpeed
2016-03-04 11:48:09 +00:00
No Flash, No Java, No Websocket, No Bullshit.
2023-08-28 20:12:08 +00:00
This is a very lightweight speed test implemented in Javascript, using XMLHttpRequest and Web Workers.
2016-03-04 11:48:09 +00:00
## Try it
2023-08-28 20:12:08 +00:00
[Take a speed test ](https://librespeed.org )
2016-03-04 11:48:09 +00:00
## Compatibility
2023-11-26 11:46:27 +00:00
All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari.
2019-06-30 05:03:06 +00:00
Works with mobile versions too.
2016-03-04 11:48:09 +00:00
2017-08-24 13:28:28 +00:00
## Features
* Download
* Upload
* Ping
* Jitter
2019-06-30 05:03:06 +00:00
* IP Address, ISP, distance from server (optional)
2017-08-24 13:28:28 +00:00
* Telemetry (optional)
2018-08-06 16:15:32 +00:00
* Results sharing (optional)
2019-06-30 05:03:06 +00:00
* Multiple Points of Test (optional)
2017-08-24 13:28:28 +00:00
2023-11-26 11:46:27 +00:00
![Screenrecording of a running Speedtest ](https://speedtest.fdossena.com/mpot_v6.gif )
2018-08-06 18:36:20 +00:00
2019-06-30 05:03:06 +00:00
## Server requirements
* A reasonably fast web server with Apache 2 (nginx, IIS also supported)
2024-02-02 14:56:48 +00:00
* PHP 5.4 or newer (other backends also available)
2023-07-31 06:10:56 +00:00
* MySQL database to store test results (optional, Microsoft SQL Server, PostgreSQL and SQLite also supported)
2019-06-30 05:03:06 +00:00
* A fast! internet connection
2016-03-04 11:48:09 +00:00
2023-11-26 11:46:27 +00:00
## Installation
Assuming you have PHP installed, the installation steps are quite simple.
I set this up on a QNAP.
For this example, I am using a folder called **speedtest** in my web share area.
2024-02-02 14:56:48 +00:00
1. Choose one of the example-xxx.html files in `examples` folder as your index.html if the default index.html does not fit.
2023-11-26 11:46:27 +00:00
2. Add: speedtest.js, speedtest_worker.js, and favicon.ico to your speedtest folder.
3. Download all of the backend folder into speedtest/backend.
4. Download all of the results folder into speedtest/results.
5. Be sure your permissions allow execute (755).
6. Visit YOURSITE/speedtest/index.html and voila!
### Installation Video
There is a more in-depth installation video here:
2019-06-30 05:03:06 +00:00
* [Quick start installation guide for Ubuntu Server 19.04 ](https://fdossena.com/?p=speedtest/quickstart_v5_ubuntu.frag )
2018-08-15 11:57:47 +00:00
2019-09-11 17:01:40 +00:00
## Android app
2019-09-25 06:27:55 +00:00
A template to build an Android client for your LibreSpeed installation is available [here ](https://github.com/librespeed/speedtest-android ).
2019-09-11 17:01:40 +00:00
2024-01-31 21:46:46 +00:00
## CLI client
A command line client is available [here ](https://github.com/librespeed/speedtest-cli ).
2017-06-24 08:38:37 +00:00
## Docker
2023-11-26 11:46:27 +00:00
A docker image is available on [GitHub ](https://github.com/librespeed/speedtest/pkgs/container/speedtest ), check our [docker documentation ](doc_docker.md ) for more info about it.
2017-06-24 08:38:37 +00:00
2020-03-02 08:14:15 +00:00
## Go backend
2020-09-27 18:35:58 +00:00
A Go implementation is available in the [`speedtest-go` ](https://github.com/librespeed/speedtest-go ) repo, maintained by [Maddie Zhan ](https://github.com/maddie ).
2020-03-02 08:14:15 +00:00
2020-03-12 10:59:40 +00:00
## Node.js backend
A partial Node.js implementation is available in the `node` branch, developed by [dunklesToast ](https://github.com/dunklesToast ). It's not recommended to use at the moment.
2017-06-26 11:18:57 +00:00
## Donate
2023-11-26 11:46:27 +00:00
[![Donate with Liberapay ](https://liberapay.com/assets/widgets/donate.svg )](https://liberapay.com/fdossena/donate)
[Donate with PayPal ](https://www.paypal.me/sineisochronic )
2017-06-26 11:18:57 +00:00
2016-03-04 11:48:09 +00:00
## License
2022-01-04 07:55:27 +00:00
Copyright (C) 2016-2022 Federico Dossena
2016-03-04 11:48:09 +00:00
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see < https: / / www . gnu . org / licenses / lgpl > .