21 Home

Federico Dossena edited this page 2023-08-29 12:18:55 +02:00

Table of Contents

• Introduction
• Main topics
• Advanced topics
• Developers
• License

Introduction

LibreSpeed is a Free and Open Source speed test that you can host on your server(s), and users can run in their browser.

Features:

• Download test
• Upload test
• Ping and Jitter test
• IP address, ISP and distance detection
• Telemetry (optional)
• Results sharing (optional)
• Multiple Points of Test (optional)

Main topics

• Browser support
• Installation
  • With PHP
    • With docker
  • Multiple test points, PHP
  • With Node.js
    • Using prebuilt binaries
• Troubleshooting, common problems, known limitations

Advanced topics

• Making a custom front-end
• Using PM2 (nodeJS only)
• Alternative backends
  • No backend
• Implementation details
  • speedtest.js
  • speedtest_worker.js
  • backend files
  • results files
• Contributing

Developers

• Federico Dossena: original author of this project, maintaining the master branch
• dunklesToast: maintainer of the Node.js port in the node branch

If you don't understand something in the documentation or this wiki, contact me at info@fdossena.com.

License

This software is under the GNU LGPL license, Version 3 or newer.

To put it short: you are free to use, study, modify, and redistribute this software and modified versions of it, for free or for money. You can also use it in proprietary software but all changes to this software must remain under the same GNU LGPL license.

Contact me at info@fdossena.com for other licensing models.

Main topics

• Browser support
• Installation
  • With PHP
    • With docker
  • Multiple test points, PHP
  • With Node.js
    • Using prebuilt binaries
  • With Go
• Troubleshooting, common problems, known limitations

Advanced topics

• Making a custom front-end
• Using PM2 (nodeJS only)
• Alternative backends
  • No backend
• Implementation details
  • speedtest.js
  • speedtest_worker.js
  • backend files
  • results files
• Contributing