speedtest README

The project's README from github.com/librespeed/speedtest. As one markdown file: README.md.

LibreSpeed Logo

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

Compatibility

All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari. Works with mobile versions too.

Features

Screenrecording of a running Speedtest

Server requirements

Installation

Assuming you have PHP and a web server installed, the installation steps are quite simple.

  1. Download the source code and extract it
  2. Copy the project files to your web server's shared folder (ie. /var/www/html/speedtest for Apache), keeping the layout as it is in the repository. The modern UI loads its assets from frontend/, so that directory is copied as a whole rather than unpacked.
  3. Optionally, copy the results folder too, and set up the database using the config file in it.
  4. Be sure your permissions allow read and execute access where needed.
  5. 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

More videos will be added later.

Android app

A template to build an Android client for your LibreSpeed installation is available here.

CLI client

A command line client is available here.

.NET client

A .NET client library is available in the LibreSpeed.NET repo (NuGet), maintained by MemphiZ.

Development

If you want to contribute or develop with LibreSpeed, see 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.

Stability test

LibreSpeed includes a standalone connection stability test at stability.html, linked from both the classic and modern interfaces. It repeatedly measures ping over a selected duration and reports current, average, minimum, maximum, jitter, and failed request percentage values with a live chart.

The stability test can target the local LibreSpeed backend, one of the configured multiple points of test, or built-in external targets such as Google, Cloudflare, and Apple. It also supports optional latency threshold alerts and CSV export of the collected samples. Docker deployments copy stability.html and stability_worker.js into the web root and reuse the same server list configuration as the main UI.

Docker

A docker image is available on GitHub, check our docker documentation 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 repo, maintained by Maddie Zhan.

Rust backend

A Rust implementation is available in the speedtest-rust repo, maintained by Sudo Dios.

Node.js backend

A partial Node.js implementation is available in the node branch, developed by dunklesToast. It's not recommended to use at the moment.

Donate

Donate with Liberapay Donate with PayPal

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.

speedtest (librespeed/speedtest)

mariadb
Searching Database…

15.2K ·GitHub
Speedtest
What is this?LibreSpeed is a self-hosted internet speed test you host on your own server, built in plain JavaScript with XMLHttpRequest and Web Workers instead of Flash or Java.
Is this a hosted service or something I run myself?It's software you install on your own web server, not a third-party hosted speed test service.
How do I get it running?Download and extract the source, copy the project files (including the frontend/ folder) into your web server's shared folder like /var/www/html/speedtest, optionally set up the results database, then visit YOURSITE/speedtest/index.html.
What does my server need to run this?A web server (Apache 2, nginx, or IIS) and PHP 5.4 or newer; a MariaDB/MySQL (or MSSQL/PostgreSQL/SQLite) database is only needed if you want to store test results.
Can I use a backend other than PHP?Yes, Go (speedtest-go) and Rust (speedtest-rust) backend implementations exist as separate maintained projects, but the partial Node.js backend in this repo's node branch is explicitly not recommended yet.
Does it work on mobile and older browsers?Yes, it supports all modern browsers including IE11, latest Edge, Chrome, Firefox, and Safari, and works with mobile browser versions too.
Can I run this with Docker instead of setting up PHP myself?Yes, an official Docker image is published and rebuilt weekly to keep the ISP-detection database updated and apply the latest PHP security patches.
Is there a ready-made Android app or CLI client?There's a template repo for building an Android client against your LibreSpeed server, a separate command-line client, and a community-maintained .NET client library on NuGet.
What can the connection stability test show that a regular speed test can't?The standalone stability.html page repeatedly pings a chosen target (your server, another test point, or Google/Cloudflare/Apple) over time and charts current, average, min, max, and jitter values, plus failed-request percentage, with optional latency alerts and CSV export.
Classic or modern UI - do I have to pick one?No, the root index.html automatically redirects to index-classic.html or index-modern.html based on the useNewDesign setting in config.json, and you can override it per-request with a ?design=new or ?design=old URL parameter.
What are similar projects?azerioid-stack-manager, caprover, typeorm, redash, Termix, cachet, flyway, SSPanel-UIM
Which topics is it in?speedtest, web-worker, sqlserver, apache, lgpl, nginx, mariadb, csv, homelab, php, mysql, sqlite
Creator
librespeed
Size
62.5 MB
Stars
15.2K
Updated
CommitSep 27Releasev6.3.0Sep 12
Age
10y
Commits · 90 Days