Release 5.4 (#645)

* Initial implementation of ipinfo.io offline database

* Removed unnecessary code

* add: download ipinfo db during docker build

* fixed workflow

* rename warning in workflow

* commit to trigger workflow

* Refactor getIP

* Improved UI

* Updated docker version with 5.4 changes

* Updated README.md

* Added fallback in getIP in case the offline db is missing

* Fixed typos

* just md linting

* Removed vscode stuff

* Implemented fallback in getIP for PHP<8 (returns only the IP)

* Updated doc.md

* Fixed comments in telemetry_settings.php

* New quick start video

* Corrected image name in doc_docker.md

* Replaced speedtest with just test in stats.php

* docker documentation update

* typo

---------

Co-authored-by: Federico Dossena <[email protected]>
Co-authored-by: Stefan Stidl <[email protected]>

.github/workflows/docker-publish.yml

@@ -37,6 +37,16 @@ jobs:
       - name: Checkout repository
         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

.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,53 +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