1 results files

Federico Dossena edited this page 2019-06-30 07:49:46 +02:00

Table of Contents

• telemetry.php
• index.php
• idObfuscation.php
• stats.php

telemetry.php

This file stores telemetry information into the database.

Data is passed as POST parameters:

• ispinfo: ISP info (if enabled, empty strng otherwise)
• extra: the telemetry_extra string passed to the worker (if set, empty string otherwise)
• dl: download speed
• ul: upload speed
• ping: ping time
• jitter: jitter value
• log: telemetry log (if telemetry_level is set to full or higher, empty string otherwise)

index.php

Generates a shareable results image for a given test ID.

GET parameters:

• id: ID of the test you want to display

The looks of this image can be customized by editing the variables in this file.

idObfuscation.php

Contains the implementation of ID obfuscation and deobfuscation.

See the code for the implementation details, it's basically a bunch of bitwise operations.

stats.php

Simple UI to display and search test results. Not required to run the test.

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