Reading the repo
Opening the box…
Reading the repo
Opening the box…
How to install on Windows
Self-hosted Speed Test for HTML5 and more. Easy setup, examples, configurable, mobile friendly. Supports PHP, Node, Multiple servers, and more
Saved setup from 6 h ago
Will it work on Windows?
All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari. Works with mobile versions too.
DEVELOPMENT.mdThis document describes how to use the package manager (npm) for development tasks.
Install development dependencies:
npm install
Check code for potential issues:
npm run lint
Automatically fix linting issues where possible:
npm run lint:fix
Check code formatting (JavaScript files only):
npm run format:check
Format JavaScript files:
npm run format
Note: The existing codebase uses its original formatting style. Prettier and ESLint are provided as optional tools for new code or improvements.
Run all checks (formatting and linting):
npm run validate
Currently, there are no automated tests configured:
npm run test
Build Docker images:
npm run docker:build # Standard Debian-based image
npm run docker:build-alpine # Alpine-based image
The package manager setup includes:
These tools are configured but non-intrusive to the existing codebase.
.
├── speedtest.js # Main speedtest library
├── speedtest_worker.js # Web Worker for speed testing
├── index.html # Default UI
├── backend/ # PHP backend files
├── examples/ # Example implementations
├── results/ # Results/telemetry handling
├── docker/ # Docker-related files
└── package.json # npm package configuration
The package manager provides several benefits:
When making changes:
npm run lint to check for potential issuesnpm run format on new files for consistencyThen run powershell -ExecutionPolicy Bypass -File .\setup.ps1. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Compare yours with the README's “Compatibility” list above before installing anything.
Needs Git: winget install Git.Git
git clone https://github.com/librespeed/speedtest.git cd speedtest
Node.js >=14.0.0
winget install CoreyButler.NVMforWindows nvm install lts nvm use lts
npm ci
npm test
Assuming you have PHP and a web server installed, the installation steps are quite simple.
/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.This video shows the installation process of a standalone LibreSpeed server: Quick start installation guide for Debian 12
More videos will be added later.
No reports for Windows yet.
GitManual AI Agent reads the 7 key files and writes a step-by-step guide for Windows. Once written, it's saved for everyone.