Merge pull request #1 from librespeed/master

update 5.3.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,5 +24,5 @@ Browser, OS, type of connection, unusual software, ...
 What should have happened
 
 ## Screenshots
-If necessary, add screenshots of the test. 
+If necessary, add screenshots of the test.
 F12 > Network screenshots can be particularly useful

.github/workflows/docker-publish.yml

@@ -0,0 +1,80 @@
+name: Docker
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+on:
+  #  schedule:
+  #    - cron: '30 20 * * *'
+  push:
+    branches: ["*"]
+    # Publish semver tags as releases.
+    tags: ["v*.*.*"]
+  pull_request:
+    branches: ["{{is_default_branch}}"]
+
+env:
+  # Use docker.io for Docker Hub if empty
+  REGISTRY: ghcr.io
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      # This is used to complete the identity challenge
+      # with sigstore/fulcio when running outside of PRs.
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # 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
+
+      # 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
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            # set latest tag for default branch
+            type=raw,value=latest,enable={{is_default_branch}}
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+
+      # Build and push Docker image with Buildx (don't push on PR)
+      # 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
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.gitignore

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

Dockerfile

@@ -1,20 +1,21 @@
-FROM php:7.4-apache
+FROM php:8-apache
 
 # Install extensions
 RUN apt-get update && apt-get install -y \
-        libfreetype6-dev \
-        libjpeg62-turbo-dev \
-        libpng-dev \
+    libfreetype6-dev \
+    libjpeg62-turbo-dev \
+    libpng-dev \
+    libpq-dev \
     && docker-php-ext-install -j$(nproc) iconv \
     && docker-php-ext-configure gd --with-freetype=/usr/include/ --with-jpeg=/usr/include/ \
-    && docker-php-ext-install -j$(nproc) gd
+    && docker-php-ext-configure pgsql -with-pgsql=/usr/local/pgsql \
+    && docker-php-ext-install -j$(nproc) gd pdo pdo_mysql pdo_pgsql pgsql \
+    && rm -rf /var/lib/apt/lists/*
 
 # Prepare files and folders
-
 RUN mkdir -p /speedtest/
 
 # Copy sources
-
 COPY backend/ /speedtest/backend
 
 COPY results/*.php /speedtest/results/
@@ -28,8 +29,7 @@ COPY docker/servers.json /servers.json
 COPY docker/*.php /speedtest/
 COPY docker/entrypoint.sh /
 
-# Prepare environment variabiles defaults
-
+# Prepare default environment variables
 ENV TITLE=LibreSpeed
 ENV MODE=standalone
 ENV PASSWORD=password
@@ -39,6 +39,5 @@ ENV REDACT_IP_ADDRESSES=false
 ENV WEBPORT=80
 
 # Final touches
-
 EXPOSE 80
 CMD ["bash", "/entrypoint.sh"]

README.md

@@ -4,13 +4,13 @@
 
 No Flash, No Java, No Websocket, No Bullshit.
 
-This is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers.
+This is a very lightweight speed test implemented in Javascript, using XMLHttpRequest and Web Workers.
 
 ## Try it
-[Take a Speedtest](https://librespeed.org)
+[Take a speed test](https://librespeed.org)
 
 ## Compatibility
-All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari.  
+All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari.
 Works with mobile versions too.
 
 ## Features
@@ -23,23 +23,36 @@ Works with mobile versions too.
 * Results sharing (optional)
 * Multiple Points of Test (optional)
 
-![Screenshot](https://speedtest.fdossena.com/mpot_v6.gif)
+![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 (other backends also available)
-* MySQL database to store test results (optional, PostgreSQL and SQLite also supported)
+* MySQL database to store test results (optional, Microsoft SQL Server, PostgreSQL and SQLite also supported)
 * A fast! internet connection
 
-## Installation videos
+## 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 as your new index.html in your speedtest folder. I used: example-singleServer-full.html
+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!
+
+### 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)
 
 ## Android app
 A template to build an Android client for your LibreSpeed installation is available [here](https://github.com/librespeed/speedtest-android).
 
 ## Docker
-A docker image is available on the [Docker Hub](https://registry.hub.docker.com/r/adolfintel/speedtest), see `doc_docker.md` for more info about it
+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.
 
 ## 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).
@@ -48,11 +61,11 @@ A Go implementation is available in the [`speedtest-go`](https://github.com/libr
 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)  
+[![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-2021 Federico Dossena
+Copyright (C) 2016-2022 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

backend/garbage.php

@@ -53,7 +53,11 @@ function sendHeaders()
 $chunks = getChunkCount();
 
 // Generate data
-$data = openssl_random_pseudo_bytes(1048576);
+if (function_exists('random_bytes')) {
+    $data = random_bytes(1048576);
+} else {
+    $data = openssl_random_pseudo_bytes(1048576);
+}
 
 // Deliver chunks of 1048576 bytes
 sendHeaders();