mirror of
https://github.com/librespeed/speedtest.git
synced 2026-05-13 16:26:38 +00:00
112 lines
5 KiB
Markdown
Executable file
112 lines
5 KiB
Markdown
Executable file
|
|
|
|
# LibreSpeed
|
|
|
|
No Flash, No Java, No Websocket, No Bullshit.
|
|
|
|
This is a very lightweight speed test implemented in Javascript, using XMLHttpRequest and Web Workers.
|
|
|
|
## Try it
|
|
|
|
[Take a speed test](https://librespeed.org)
|
|
|
|
## Compatibility
|
|
|
|
All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari.
|
|
Works with mobile versions too.
|
|
|
|
## Features
|
|
|
|
* Download
|
|
* Upload
|
|
* Ping
|
|
* Jitter
|
|
* IP Address, ISP, distance from server (optional)
|
|
* Telemetry (optional)
|
|
* Results sharing (optional)
|
|
* Multiple Points of Test (optional)
|
|
|
|
|
|
|
|
## Server requirements
|
|
|
|
* A reasonably fast web server with Apache 2 (nginx, IIS also supported)
|
|
* PHP 5.4 or newer (other backends also available)
|
|
* MariaDB or MySQL database to store test results (optional, Microsoft SQL Server, PostgreSQL and SQLite also supported)
|
|
* A fast! internet connection
|
|
|
|
## Installation
|
|
|
|
Assuming you have PHP and a web server installed, the installation steps are quite simple.
|
|
|
|
1. Download the source code and extract it
|
|
1. Copy the project files to your web server's shared folder (ie. `/var/www/html/speedtest` for Apache). For the current layout, the web root should contain `index.html`, `index-classic.html`, `index-modern.html`, `design-switch.js`, `config.json`, `speedtest.js`, `speedtest_worker.js`, `favicon.ico`, and the `backend` folder.
|
|
1. Also copy the contents of `frontend/` into the same web root so the modern UI assets end up in `styling/`, `javascript/`, `images/`, and `fonts/` next to the HTML files.
|
|
1. Optionally, copy the results folder too, and set up the database using the config file in it.
|
|
1. Be sure your permissions allow read and execute access where needed.
|
|
1. Visit YOURSITE/speedtest/index.html and voila!
|
|
|
|
### Installation Video
|
|
|
|
This video shows the installation process of a standalone LibreSpeed server: [Quick start installation guide for Debian 12](https://fdossena.com/?p=speedtest/quickstart_deb12.frag)
|
|
|
|
More videos will be added later.
|
|
|
|
## Android app
|
|
|
|
A template to build an Android client for your LibreSpeed installation is available [here](https://github.com/librespeed/speedtest-android).
|
|
|
|
## CLI client
|
|
|
|
A command line client is available [here](https://github.com/librespeed/speedtest-cli).
|
|
|
|
## .NET client
|
|
|
|
A .NET client library is available in the [`LibreSpeed.NET`](https://github.com/Memphizzz/LibreSpeed.NET) repo ([NuGet](https://www.nuget.org/packages/LibreSpeed.NET)), maintained by [MemphiZ](https://github.com/Memphizzz).
|
|
|
|
## Development
|
|
|
|
If you want to contribute or develop with LibreSpeed, see [DEVELOPMENT.md](DEVELOPMENT.md) for information about using npm for development tasks, linting, and formatting.
|
|
|
|
## Design switch
|
|
|
|
LibreSpeed supports both the classic and modern UI. The root `index.html` acts as a lightweight switcher and redirects to `index-classic.html` or `index-modern.html` based on `config.json` (`useNewDesign`) or URL overrides (`?design=new` / `?design=old`). For architecture and deployment details (including Docker behavior), see [DESIGN_SWITCH.md](DESIGN_SWITCH.md).
|
|
|
|
## Docker
|
|
|
|
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.
|
|
The image is built every week to include an updated version of the ipinfo-DB used for ISP detection. Also this ensures, that the latest security patches in PHP are installed. Therefore we recommend to use the `latest` image.
|
|
|
|
## 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).
|
|
|
|
## Rust backend
|
|
|
|
A Rust implementation is available in the [`speedtest-rust`](https://github.com/librespeed/speedtest-rust) repo, maintained by [Sudo Dios](https://github.com/sudodios).
|
|
|
|
## 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.
|
|
|
|
## Donate
|
|
|
|
[](https://liberapay.com/fdossena/donate)
|
|
[Donate with PayPal](https://www.paypal.me/sineisochronic)
|
|
|
|
## License
|
|
|
|
Copyright (C) 2016-2024 Federico Dossena
|
|
|
|
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>.
|