speedtest/README.md

69 lines
2.6 KiB
Markdown
Raw Normal View History

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.
2016-11-28 20:09:12 +00:00
This is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers.
2016-03-04 11:48:09 +00:00
## Try it
2020-03-12 10:59:40 +00:00
[Take a Speedtest](https://librespeed.org)
2016-03-04 11:48:09 +00:00
## Compatibility
All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari.
Works with mobile versions too.
2016-03-04 11:48:09 +00:00
## Features
* Download
* Upload
* Ping
* Jitter
* IP Address, ISP, distance from server (optional)
* Telemetry (optional)
* Results sharing (optional)
* Multiple Points of Test (optional)
2019-09-26 10:28:53 +00:00
![Screenshot](https://speedtest.fdossena.com/mpot_v6.gif)
2018-08-06 18:36:20 +00:00
## Server requirements
* A reasonably fast web server with Apache 2 (nginx, IIS also supported)
* PHP 5.4 (other backends also available)
* MySQL database to store test results (optional, PostgreSQL and SQLite also supported)
* A fast! internet connection
2016-03-04 11:48:09 +00:00
## Installation videos
* [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
2017-06-24 08:38:37 +00:00
## Docker
A docker image is available on the [Docker Hub](https://registry.hub.docker.com/r/adolfintel/speedtest), see `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
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
2018-04-25 14:56:53 +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
2021-02-24 07:18:01 +00:00
Copyright (C) 2016-2021 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>.