speedtest-rust

No Flash, No Java, No WebSocket, No Bullshit.

Try it

Take a speed test

Compatibility

Compatible with all librespeed clients :

Attributes

Memory safety (uses #![forbid(unsafe_code)] to ensure everything is implemented in 100% safe Rust.)
Lightweight & Low overhead
Low level networking
Based on tokio-rs (asynchronous)

Features

Download
Upload
Ping
Jitter
IP Address, ISP
Telemetry (optional)
Results sharing (optional)

Server requirements

Any Rust supported platforms
PostgreSQL or MySQL database to store test results (optional)
A fast! Internet connection

Installation

Install using prebuilt binaries

Download the appropriate binary file from the releases page.
Unzip the archive.
Make changes to the configuration.
Run the binary.
Or setup as service :
- Copy setup_systemd.sh on linux or setup_sc_win.bat on windows system in extracted folder.
- Run the script file to setup as service

Build with docker

Install docker and docker-compose.

Clone the repository:

$ git clone https://github.com/librespeed/speedtest-rust.git
$ cd speedtest-rust

Copy the default config and assets:

$ cp docker-compose.override.sample.yml docker-compose.override.yml
$ sudo mkdir /var/lib/librespeed
$ sudo cp configs.toml /etc/librespeed.toml
$ sudo cp -r assets /var/lib/librespeed/assets

Edit the config files:

$ sudo chmod o-rwx /etc/librespeed.toml docker-compose.override.yml # Hide secrets
$ $EDITOR docker-compose.override.yml # Docker settings
$ sudo $EDITOR /etc/librespeed.toml # Librespeed settings
$ sudo $EDITOR /var/lib/librespeed/assets/servers_list.js # To set server name and remote servers
$ sudo $EDITOR /var/lib/librespeed/assets/index.html # To change html styles, etc

Start the container:

$ docker compose up -d
$ docker compose logs -f # To check status

Navigate to http://localhost:8080/

Compile from source

You need Rust 1.74+ to compile project.
So make sure that rust is properly installed on your system

Clone the repository:

$ git clone https://github.com/librespeed/speedtest-rust.git

Build:

# cd to cloned directory
$ cargo build --release

Prepare files:

# Make a new directory
# Copy target/release/librespeed-rs to created directory
# Copy configs.toml to created directory
# If you want the server to load the speedtest web front in the route `/`,
  then you must specify the path of the client folder in the configs.toml file.

Change configs.toml according to your environment:

# bind socket adress
bind_address="0.0.0.0"
# socket listent port, default is 8080
listen_port=8080

# you can specify the number of worker threads. default is 1
# auto: number of cpu cores, or more than 0 as desired
# increasing the count increases memory usage
worker_threads=1

# base api url /{base_url}/routes
base_url="backend"

# ipinfo.io API key, If the api-key works, the priority is with the api, if not with the offline database
ipinfo_api_key=""

# set directory of speedtest web front to server load on `/`. If it is empty, default web will be returned
assets_path="./assets" # Write without suffix separator

# password for logging into statistics page, fill this to enable stats page
stats_password=""

# redact IP addresses
redact_ip_addresses=false

# set telemetry result image theme : light, dark
# default is light
result_image_theme="light"

# database config for : mysql, postgres, sqlite, memory, or disable by write none
# after restarting the service, the in-memory database is reset
# if none is specified, no telemetry/stats will be recorded, and no result JPG will be generated
database_type="sqlite"
database_hostname="localhost"
database_name="speedtest_db"
database_username=""
database_password=""
# if you use `sqlite` as database, set database_file to database file location
database_file="speedtest.db"

# enable and use TLS option; if enable it, you need to prepare certificates and private keys
enable_tls=false
tls_cert_file=""
tls_key_file=""

ISP Detection

This project use offline database for detect ip ISPs
Currently, only the ipinfo.io database is supported
You can download or update database automatically by typing :
```
$ librespeed-rs --update-ipdb
```

Note :

This project can be much better.
Therefore, your PRs are accepted to improve and solve problems

License

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 the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/lgpl.