Merge branch 'librespeed:master' into master

.github/workflows/docker-publish.yml

@@ -14,6 +14,8 @@ on:
  tags: ["v*.*.*"]
  pull_request:
  branches: ["{{is_default_branch}}"]
+ release:
+ types: [published]
 
 env:
  # Use docker.io for Docker Hub if empty
@@ -33,19 +35,29 @@ jobs:
 
  steps:
  - name: Checkout repository
- uses: actions/checkout@v3
+ uses: actions/checkout@v4
+
+ # Fetch the ipinfo database file using curl if API key is defined
+ - name: Fetch DB from ipinfo.io
+ # IPINFO_APIKEY is set in https://github.com/librespeed/speedtest/settings/secrets/actions
+ run: |
+ if [ -z "${{ secrets.IPINFO_APIKEY }}" ]; then
+ echo "Warning: IPINFO_APIKEY is not defined."
+ else
+ curl -L https://ipinfo.io/data/free/country_asn.mmdb?token=${{ secrets.IPINFO_APIKEY }} -o backend/country_asn.mmdb
+ fi
 
  # Set up BuildKit Docker container builder to be able to build
  # multi-platform images and export cache
  # https://github.com/docker/setup-buildx-action
  - name: Set up Docker Buildx
- uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0
+ uses: docker/setup-buildx-action@v3
 
  # Login against a Docker registry except on PR
  # https://github.com/docker/login-action
  - name: Log into registry ${{ env.REGISTRY }}
  if: github.event_name != 'pull_request'
- uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
+ uses: docker/login-action@v3
  with:
  registry: ${{ env.REGISTRY }}
  username: ${{ github.actor }}
@@ -55,7 +67,7 @@ jobs:
  # https://github.com/docker/metadata-action
  - name: Extract Docker metadata
  id: meta
- uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
+ uses: docker/metadata-action@v5
  with:
  images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
  tags: |
@@ -70,7 +82,7 @@ jobs:
  # https://github.com/docker/build-push-action
  - name: Build and push Docker image
  id: build-and-push
- uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
+ uses: docker/build-push-action@v5
  with:
  context: .
  platforms: linux/amd64,linux/arm64

.gitignore

@@ -1,3 +1,4 @@
 results/idObfuscation_salt.php
 backend/getIP_serverLocation.php
 db-dir/
+.vscode/

README.md

@@ -7,13 +7,16 @@ 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](https://librespeed.org)
 
 ## Compatibility
+
 All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari.
 Works with mobile versions too.
 
 ## Features
+
 * Download
 * Upload
 * Ping
@@ -25,50 +28,62 @@ Works with mobile versions too.
 
 ![Screenrecording of a running Speedtest](https://speedtest.fdossena.com/mpot_v6.gif)
 
-
 ## Server requirements
+
 * A reasonably fast web server with Apache 2 (nginx, IIS also supported)
 * PHP 5.4 or newer (other backends also available)
 * MySQL database to store test results (optional, Microsoft SQL Server, PostgreSQL and SQLite also supported)
 * A fast! internet connection
 
 ## Installation
-Assuming you have PHP installed, the installation steps are quite simple.
-I set this up on a QNAP.
-For this example, I am using a folder called **speedtest** in my web share area.
 
-1. Choose one of the example-xxx.html files in `examples` folder as your index.html if the default index.html does not fit.
-2. Add: speedtest.js, speedtest_worker.js, and favicon.ico to your speedtest folder.
-3. Download all of the backend folder into speedtest/backend.
-4. Download all of the results folder into speedtest/results.
-5. Be sure your permissions allow execute (755).
-6. Visit YOURSITE/speedtest/index.html and voila!
+Assuming you have PHP and a web server installed, the installation steps are quite simple.
+
+1. Download the source code and extract it
+1. Copy the following files to your web server's shared folder (ie. /var/www/html/speedtest for Apache): index.html, speedtest.js, speedtest_worker.js, favicon.ico and the backend folder
+1. Optionally, copy the results folder too, and set up the database using the config file in it.
+1. Be sure your permissions allow execute (755).
+1. Visit YOURSITE/speedtest/index.html and voila!
 
 ### Installation Video
-There is a more in-depth installation video here:
-* [Quick start installation guide for Ubuntu Server 19.04](https://fdossena.com/?p=speedtest/quickstart_v5_ubuntu.frag)
+
+This video shows the installation process of a standalone LibreSpeed server: [Quick start installation guide for Debian 12](https://fdossena.com/?p=speedtest/quickstart_deb12.frag)
+
+More videos will be added later.
 
 ## Android app
+
 A template to build an Android client for your LibreSpeed installation is available [here](https://github.com/librespeed/speedtest-android).
 
 ## CLI client
+
 A command line client is available [here](https://github.com/librespeed/speedtest-cli).
 
 ## Docker
+
 A docker image is available on [GitHub](https://github.com/librespeed/speedtest/pkgs/container/speedtest), check our [docker documentation](doc_docker.md) 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`](https://github.com/librespeed/speedtest-go) repo, maintained by [Maddie Zhan](https://github.com/maddie).
 
+## Rust backend
+
+A Rust implementation is available in the [`speedtest-rust`](https://github.com/librespeed/speedtest-rust) repo, maintained by [Sudo Dios](https://github.com/sudodios).
+
 ## Node.js backend
+
 A partial Node.js implementation is available in the `node` branch, developed by [dunklesToast](https://github.com/dunklesToast). It's not recommended to use at the moment.
 
 ## Donate
+
 [![Donate with Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/fdossena/donate)
 [Donate with PayPal](https://www.paypal.me/sineisochronic)
 
 ## License
-Copyright (C) 2016-2022 Federico Dossena
+
+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