beenull/speedtest
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Maddie Zhan 2020-04-20 09:12:23 +08:00
parent a5960daecf
commit fe92cbeed2
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -10,7 +10,7 @@ This is a very lightweight speed test implemented in JavaScript, using XMLHttpRe
[Take a speed test](https://speedtest.fdossena.com) (PHP implementation) [Take a speed test](https://speedtest.fdossena.com) (PHP implementation)
## Compatibility ## 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. Works with mobile versions too.
## Features ## Features
@ -50,7 +50,7 @@ You need Go 1.13+ to compile the binary.
# Compile # Compile
$ go build -ldflags "-w -s" -trimpath -o speedtest main.go $ go build -ldflags "-w -s" -trimpath -o speedtest main.go
``` ```
3. Copy the `assets` directory, `settings.toml` file along with the compiled `speedtest` binary into a single directory 3. Copy the `assets` directory, `settings.toml` file along with the compiled `speedtest` binary into a single directory
4. If you have telemetry enabled, 4. If you have telemetry enabled,
@ -60,9 +60,9 @@ You need Go 1.13+ to compile the binary.
# assume you have already created a database named `speedtest` under current user # assume you have already created a database named `speedtest` under current user
$ psql speedtest < database/postgresql/telemetry_postgresql.sql $ psql speedtest < database/postgresql/telemetry_postgresql.sql
``` ```
- For embedded BoltDB, make sure to define the `database_file` path in `settings.toml`: - For embedded BoltDB, make sure to define the `database_file` path in `settings.toml`:
``` ```
database_file="speedtest.db" database_file="speedtest.db"
``` ```
@ -80,21 +80,24 @@ You need Go 1.13+ to compile the binary.
bind_address="127.0.0.1" bind_address="127.0.0.1"
# backend listen port, default is 8989 # backend listen port, default is 8989
listen_port=8989 listen_port=8989
# Server location
server_lat=0
server_lng=0
# ipinfo.io API key, if applicable # ipinfo.io API key, if applicable
ipinfo_api_key="" ipinfo_api_key=""
# password for logging into statistics page, change this to enable stats page # password for logging into statistics page, change this to enable stats page
statistics_password="PASSWORD" statistics_password="PASSWORD"
# redact IP addresses # redact IP addresses
redact_ip_addresses=false redact_ip_addresses=false
# database type for statistics data, currently supports: bolt, mysql, postgresql # database type for statistics data, currently supports: bolt, mysql, postgresql
database_type="postgresql" database_type="postgresql"
database_hostname="localhost" database_hostname="localhost"
database_name="speedtest" database_name="speedtest"
database_username="postgres" database_username="postgres"
database_password="" database_password=""
# if you use `bolt` as database, set database_file to database file location # if you use `bolt` as database, set database_file to database file location
database_file="speedtest.db" database_file="speedtest.db"
``` ```
@ -105,12 +108,13 @@ You need Go 1.13+ to compile the binary.
instead, as an embedded database alternative to SQLite instead, as an embedded database alternative to SQLite
- Test IDs are generated ULID, there is no option to change them to plain ID - Test IDs are generated ULID, there is no option to change them to plain ID
- You can use the same HTML template from the PHP implementation - You can use the same HTML template from the PHP implementation
- Server location can be defined in settings
- There might be a slight delay on program start if your Internet connection is slow. That's because the program will - There might be a slight delay on program start if your Internet connection is slow. That's because the program will
attempt to fetch your current network's ISP info for distance calculation between your network and the speed test client's. attempt to fetch your current network's ISP info for distance calculation between your network and the speed test client's.
This action will only be taken once, and cached for later use. This action will only be taken once, and cached for later use.
## License ## License
Copyright (C) 2016-2020 Federico Dossena Copyright (C) 2016-2020 Federico Dossena
Copyright (C) 2020 Maddie Zhan Copyright (C) 2020 Maddie Zhan
This program is free software: you can redistribute it and/or modify This program is free software: you can redistribute it and/or modify