speedtest/doc.md

LibreSpeed - Docker Documentation

Downloading from Docker hub

To download LibreSpeed from the docker hub, use this command:

docker pull adolfintel/speedtest

You will now have a new docker image called adolfintel/speedtest.

Standalone mode

If you want to install LibreSpeed on a single server, you need to configure it in standalone mode. To do this, set the MODE environment variable to standalone.

The test can be accessed on port 80.

Here's a list of additional environment variables available in this mode:

• TITLE: Title of your speedtest. Default value: LibreSpeed
• TELEMETRY: Whether to enable telemetry or not. Default value: false
• ENABLE_ID_OBFUSCATION: When set to true with telemetry enabled, test IDs are obfuscated, to avoid exposing the database internal sequential IDs. Default value: false
• REDACT_IP_ADDRESSES: When set to true with telemetry enabled, IP addresses and hostnames are redacted from the collected telemetry, for better privacy. Default value: false
• PASSWORD: Password to access the stats page. If not set, stats page will not allow accesses.
• EMAIL: Email address for GDPR requests. Must be specified when telemetry is enabled.
• IPINFO_APIKEY: API key for ipinfo.io. Optional, but required if you expect to serve a large number of tests

If telemetry is enabled, a stats page will be available at http://your.server/results/stats.php, but a password must be specified.

Example

This command starts LibreSpeed in standalone mode, with the default settings, on port 80:

docker run -e MODE=standalone -p 80:80 -it adolfintel/speedtest

This command starts LibreSpeed in standalone mode, with telemetry, ID obfuscation and a stats password, on port 80:

docker run -e MODE=standalone -e TELEMETRY=true -e ENABLE_ID_OBFUSCATION=true -e PASSWORD="botnet!123" -p 80:80 -it adolfintel/speedtest

Multiple Points of Test

For multiple servers, you need to set up 1+ LibreSpeed backends, and 1 LibreSpeed frontend.

Backend mode

In backend mode, LibreSpeed provides only a test point with no UI. To do this, set the MODE environment variable to backend.

The following backend files can be accessed on port 80: garbage.php, empty.php, getIP.php

Here's a list of additional environment variables available in this mode:

• IPINFO_APIKEY: API key for ipinfo.io. Optional, but required if you expect to serve a large number of tests

Example:

This command starts LibreSpeed in backend mode, with the default settings, on port 80:

docker run -e MODE=backend -p 80:80 -it adolfintel/speedtest

Frontend mode

In frontend mode, LibreSpeed serves clients the Web UI and a list of servers. To do this:

• Set the MODE environment variable to frontend
• Create a servers.json file with your test points. The syntax is the following:

  [
      {
          "name": "Friendly name for Server 1",
          "server" :"//server1.mydomain.com/",
          "dlURL" :"garbage.php",
          "ulURL" :"empty.php",
          "pingURL" :"empty.php",
          "getIpURL" :"getIP.php"
      },
      {
          "name": "Friendly name for Server 2",
          "server" :"https://server2.mydomain.com/",
          "dlURL" :"garbage.php",
          "ulURL" :"empty.php",
          "pingURL" :"empty.php",
          "getIpURL" :"getIP.php"
      },
      ...more servers...
  ]
  

  Note: if a server only supports HTTP or HTTPS, specify the protocol in the server field. If it supports both, just use //.
• Mount this file to /servers.json in the container

The test can be accessed on port 80.

Here's a list of additional environment variables available in this mode:

• TITLE: Title of your speedtest. Default value: LibreSpeed
• TELEMETRY: Whether to enable telemetry or not. Default value: false
• ENABLE_ID_OBFUSCATION: When set to true with telemetry enabled, test IDs are obfuscated, to avoid exposing the database internal sequential IDs. Default value: false
• REDACT_IP_ADDRESSES: When set to true with telemetry enabled, IP addresses and hostnames are redacted from the collected telemetry, for better privacy. Default value: false
• PASSWORD: Password to access the stats page. If not set, stats page will not allow accesses.
• EMAIL: Email address for GDPR requests. Must be specified when telemetry is enabled.

Example

This command starts LibreSpeed in frontend mode, with a given servers.json file, and with telemetry, ID obfuscation, and a stats password:

docker run -e MODE=frontend -e TELEMETRY=true -e ENABLE_ID_OBFUSCATION=true -e PASSWORD="botnet!123" -v ./my_servers.json:/servers.json -p 80:80 -it adolfintel/speedtest