OpenSpeedTest Documentation

To use your own SSL certificates, prepare a folder containing your certificate and key files renamed exactly to nginx.crt and nginx.key. Then, mount this folder to /etc/ssl/ in the container.

Example using Docker CLI:

sudo docker run -v /${PATH-TO-YOUR-OWN-SSL-CERTIFICATE}:/etc/ssl/ --restart=unless-stopped --name openspeedtest -d -p 3000:3000 -p 3001:3001 openspeedtest/latest

Example using Docker Compose:

version: '3.3'
services:
    speedtest:
        volumes:
            - '/Users/vishnu/Desktop/docker/:/etc/ssl/'
        restart: unless-stopped
        container_name: openspeedtest
        ports:
            - '3000:3000'
            - '3001:3001'
        image: openspeedtest/latest

For advanced customization, you can edit the Index.html file directly to implement the following features:

Save results to a Database

Set saveData to true and provide your endpoint URL:

var saveData = true;
var saveDataURL = "//yourDatabase.Server.com:4500/save?data=";

Add multiple servers

Define a list of servers. The application will automatically select the one with the lowest latency:

var openSpeedTestServerList = [
  {"ServerName":"Home-Earth", "Download":"/downloading", "Upload":"/upload", "ServerIcon":"DefaultIcon"},
  {"ServerName":"Home-Mars", "Download":"/downloading", "Upload":"/upload", "ServerIcon":"DefaultIcon"},
  {"ServerName":"Home-Moon", "Download":"/downloading", "Upload":"/upload", "ServerIcon":"DefaultIcon"}
];

Use the following docker-compose.yml configuration to deploy the OpenSpeedTest service.

version: '3.3'
services:
    speedtest:
        restart: unless-stopped
        container_name: openspeedtest
        ports:
            - '3000:3000'
            - '3001:3001'
        image: openspeedtest/latest

To host OpenSpeedTest yourself, you need a static web server (e.g., Nginx, Apache, IIS, Express) that supports HTTP/1.1 or newer. Ensure your server meets these requirements:

• Supports GET, POST, HEAD, and OPTIONS methods with 200 OK responses.
• Supports POST to static files with 200 OK responses.
• client_max_body_size is set to at least 35 Megabytes.
• Timeout is greater than 60 seconds.
• Disable Access logs to improve server performance and reduce TTFB.
• If using a Reverse Proxy, ensure the post-body content length is increased to at least 35 megabytes.
• Supports HTTP2 and HTTP3 (though HTTP1.1 is recommended for maximum performance).

To deploy OpenSpeedTest as a container, use the openspeedtest/latest image. The implementation uses nginxinc/nginx-unprivileged:stable-alpine to run NGINX as a non-root user, which is resource-efficient.

Accessing the server:

• HTTP: http://YOUR-SERVER-IP:3000
• HTTPS: https://YOUR-SERVER-IP:3001

Port Mapping:

• To change the host port for HTTP (default 3000), use -p <NEW_PORT>:3000.
• To change the host port for HTTPS (default 3001), use -p <NEW_PORT>:3001.

sudo docker run --restart=unless-stopped --name openspeedtest -d -p 3000:3000 -p 3001:3001 openspeedtest/latest

You can automatically generate and renew Let's Encrypt certificates by providing specific environment variables.

Requirements:

• A public IPv4 or IPv6 address.
• A domain name resolving to the server's IP.
• A valid email address.

Docker Command:

docker run -e ENABLE_LETSENCRYPT=True -e DOMAIN_NAME=speedtest.yourdomain.com -e USER_EMAIL=you@yourdomain.pro --restart=unless-stopped --name openspeedtest -d -p 80:3000 -p 443:3001 openspeedtest/latest

Docker Compose:

version: '3.3'
services:
    speedtest:
        environment:
            - ENABLE_LETSENCRYPT=True
            - DOMAIN_NAME=speedtest.yourdomain.com
            - USER_EMAIL=you@yourdomain.pro
        restart: unless-stopped
        container_name: openspeedtest
        ports:
            - '80:3000'
            - '443:3001'
        image: openspeedtest/latest

Use the following environment variables to customize the OpenSpeedTest Docker container behavior: