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)

Searching Database…

15.2K ·GitHub
Speedtest
Что это такое?LibreSpeed — это тест скорости интернета, который вы размещаете на собственном сервере. Он написан на простом JavaScript с использованием XMLHttpRequest и Web Workers вместо Flash или Java.
Это готовый онлайн-сервис или программа, которую я запускаю сам?Это программа, которую вы устанавливаете на свой веб-сервер, а не сторонний онлайн-сервис для проверки скорости.
Как его запустить?Скачайте и распакуйте исходный код, скопируйте файлы проекта (включая папку frontend/) в публичную папку веб-сервера, например /var/www/html/speedtest, при желании настройте базу данных для результатов, затем откройте YOURSITE/speedtest/index.html.
Что нужно на сервере для работы?Веб-сервер (Apache 2, nginx или IIS) и PHP 5.4 или новее; база данных MariaDB/MySQL (или MSSQL/PostgreSQL/SQLite) нужна только если вы хотите сохранять результаты тестов.
Можно ли использовать бэкенд не на PHP?Да, существуют реализации бэкенда на Go (speedtest-go) и Rust (speedtest-rust) как отдельные поддерживаемые проекты, но частичная реализация на Node.js в ветке node этого репозитория пока прямо не рекомендуется.
Работает ли это на мобильных устройствах и старых браузерах?Да, поддерживаются все современные браузеры, включая IE11, последние версии Edge, Chrome, Firefox и Safari, а также мобильные версии браузеров.
Можно ли запустить это через Docker вместо ручной настройки PHP?Да, опубликован официальный Docker-образ, который пересобирается раз в неделю, чтобы база данных для определения провайдера оставалась актуальной и применялись последние обновления безопасности PHP.
Есть ли готовое приложение для Android или клиент для командной строки?Есть шаблонный репозиторий для создания клиента для Android, работающего с вашим сервером LibreSpeed, отдельный клиент для командной строки и клиентская библиотека для .NET в NuGet, которую поддерживает сообщество.
Что может показать тест стабильности соединения, чего не покажет обычный тест скорости?Отдельная страница stability.html многократно пингует выбранную цель (ваш сервер, другую тестовую точку или Google/Cloudflare/Apple) в течение времени и выводит графики текущих, средних, минимальных и максимальных значений, а также джиттера и процента неудачных запросов. Есть необязательные оповещения о задержке и экспорт в CSV.
Классический или современный интерфейс — обязательно выбирать один?Нет, корневой index.html автоматически перенаправляет на index-classic.html или index-modern.html в зависимости от настройки useNewDesign в config.json. А для каждого запроса можно переопределить выбор через параметр в адресе: ?design=new или ?design=old.
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