Images

linuxserver/librespeed

GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry MicroBadger Layers Docker Pulls Docker Stars Jenkins Build LSIO CI

Librespeed is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers. No Flash, No Java, No Websocket, No Bullshit.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling ghcr.io/linuxserver/librespeed should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture

Tag

x86-64

amd64-latest

arm64

arm64v8-latest

armhf

arm32v7-latest

Usage

Here are some example snippets to help you get started creating a container from this image.

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
librespeed:
image: ghcr.io/linuxserver/librespeed
container_name: librespeed
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- PASSWORD=PASSWORD
- CUSTOM_RESULTS=true #optional
- DB_TYPE=sqlite #optional
- DB_NAME=DB_NAME #optional
- DB_HOSTNAME=DB_HOSTNAME #optional
- DB_USERNAME=DB_USERNAME #optional
- DB_PASSWORD=DB_PASSWORD #optional
volumes:
- /path/to/appdata/config:/config
ports:
- 80:80
restart: unless-stopped

docker cli

docker run -d \
--name=librespeed \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e PASSWORD=PASSWORD \
-e CUSTOM_RESULTS=true `#optional` \
-e DB_TYPE=sqlite `#optional` \
-e DB_NAME=DB_NAME `#optional` \
-e DB_HOSTNAME=DB_HOSTNAME `#optional` \
-e DB_USERNAME=DB_USERNAME `#optional` \
-e DB_PASSWORD=DB_PASSWORD `#optional` \
-p 80:80 \
-v /path/to/appdata/config:/config \
--restart unless-stopped \
ghcr.io/linuxserver/librespeed

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter

Function

80

web gui

Environment Variables (-e)

Env

Function

PUID=1000

for UserID - see below for explanation

PGID=1000

for GroupID - see below for explanation

TZ=Europe/London

Specify a timezone to use EG Europe/London

PASSWORD=PASSWORD

Set the password for the results database.

CUSTOM_RESULTS=true

(optional) enables custom results page in /config/www/results/index.php.

DB_TYPE=sqlite

Defaults to sqlite, can also be set to mysql or postgresql.

DB_NAME=DB_NAME

Database name. Required for mysql and pgsql.

DB_HOSTNAME=DB_HOSTNAME

Database address. Required for mysql and pgsql.

DB_USERNAME=DB_USERNAME

Database username. Required for mysql and pgsql.

DB_PASSWORD=DB_PASSWORD

Database password. Required for mysql and pgsql.

Volume Mappings (-v)

Volume

Function

/config

Contains all relevant configuration files.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Application Setup

Access the speedtest webui at http://SERVERIP. The results database can be accessed at http://SERVERIP/results/stats.php with the password set. The default template used is based on example-singleServer-full.html. However, all templates are provided for reference at /config/www/. Feel free to customize /config/www/index.html as you like. Delete the file and restart to go back to the image default.

You can optionally place customized speedtest.js and speedtest_worker.js files under /config/www and they will supersede the defaults after a container start. Keep in mind that once you do so, they will no longer be updated. You can delete them and recreate the container to go back to the image defaults.

If you are setting up a mysql or postgresql database, you first need to import the tables into your database as described at the following link https://github.com/librespeed/speedtest/blob/master/doc.md#creating-the-database

To enable a custom results page set the environment variable CUSTOM_RESULTS=true and start (or restart) the container at least once for /config/www/results/index.php to be created and modify this file to your liking.

Docker Mods

Docker Mods Docker Universal Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

  • Shell access whilst the container is running:

    • docker exec -it librespeed /bin/bash

  • To monitor the logs of the container in realtime:

    • docker logs -f librespeed

  • Container version number

    • docker inspect -f '{{ index .Config.Labels "build_version" }}' librespeed

  • Image version number

    • docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/librespeed

Versions

  • 01.06.20: - Rebasing to alpine 3.12.

  • 29.04.20: - Add donation links for LibreSpeed to Github sponsor button and container log.

  • 09.01.20: - Initial Release.