Merge branch 'master' into dev
This commit is contained in:
Stefan Stidl
commit
ac1d806490
|
|
@ -28,7 +28,7 @@ Works with mobile versions too.
|
|||
|
||||
## Server requirements
|
||||
* A reasonably fast web server with Apache 2 (nginx, IIS also supported)
|
||||
* PHP 5.4 (other backends also available)
|
||||
* PHP 5.4 or newer (other backends also available)
|
||||
* MySQL database to store test results (optional, Microsoft SQL Server, PostgreSQL and SQLite also supported)
|
||||
* A fast! internet connection
|
||||
|
||||
|
|
@ -37,7 +37,7 @@ 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
|
||||
1. Choose one of the example-xxx.html files in `examples` folder as your index.html if the default index.html does not fit.
|
||||
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.
|
||||
|
|
@ -51,6 +51,9 @@ There is a more in-depth installation video here:
|
|||
## Android app
|
||||
A template to build an Android client for your LibreSpeed installation is available [here](https://github.com/librespeed/speedtest-android).
|
||||
|
||||
## CLI client
|
||||
A command line client is available [here](https://github.com/librespeed/speedtest-cli).
|
||||
|
||||
## Docker
|
||||
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.
|
||||
|
||||
|
|
|
|||
9
doc.md
9
doc.md
|
|
@ -109,8 +109,7 @@ A basic front-end for visualizing and searching tests by ID is available in `res
|
|||
A login is required to access the interface. __Important__: change the default password in `results/telemetry_settings.php`.
|
||||
|
||||
#### The end
|
||||
Now that the test is installed, rename one of the examples to `index.html` and delete the other examples.
|
||||
The best starting point for most people is `example-singleServer-gauges.html`. If you want to use telemetry and results sharing, use `example-singleServer-full.html` instead.
|
||||
Now that the test is installed, the default page uses telemetry and results sharing. If you want another index page, rename one of the examples to `index.html` and delete the other examples. The best starting point for most people is `example-singleServer-gauges.html`.
|
||||
|
||||
If you're not using telemetry and results sharing, you can delete the `results` folder too.
|
||||
|
||||
|
|
@ -119,7 +118,7 @@ Details about the examples and how to make custom UIs will be discussed later. I
|
|||
#### Privacy
|
||||
Telemetry contains personal information (according to GDPR definition), therefore it is important to treat this data respectfully of national and international laws, especially if you plan to offer the service in the European Union.
|
||||
|
||||
`example-singleServer-full.html` and `example-multipleServers-full.html` both contain a privacy policy for the service: you MUST read it, change it if necessary, and add your email address for data deletion requests. __Failure to comply with GDPR regulations can get you in serious trouble.__
|
||||
Default `index.html` and `example-multipleServers-full.html` both contain a privacy policy for the service: you MUST read it, change it if necessary, and add your email address for data deletion requests. __Failure to comply with GDPR regulations can get you in serious trouble.__
|
||||
|
||||
### Multiple servers, PHP
|
||||
The speed test can automatically choose between multiple test points and use the one with the lowest ping in a list.
|
||||
|
|
@ -240,11 +239,11 @@ __Single server:__
|
|||
* `example-singleServer-customSettings.html`: Same as `example-singleServer-pretty.html` but configures the test so that it only performs download and upload tests, and with a fixed length instead of automatic
|
||||
* `example-singleServer-gauges.html`: The most sophisticated example, with the same functionality as `example-singleServer-pretty.html` but adds gauges. This is also a good starting point, but the gauges may slow down underpowered devices
|
||||
* `example-singleServer-chart.html`: Shows how to use the test with the Chart.js library
|
||||
* `example-singleServer-full.html`: The most complete example. Based on `example-singleServer-gauges.html`, also enables telemetry and results sharing
|
||||
* default `index.html`: The most complete example. Based on `example-singleServer-gauges.html`, also enables telemetry and results sharing
|
||||
|
||||
__Multiple servers:__
|
||||
* `example-multipleServers-pretty.html`: Same as `example-singleServer-pretty.html` but with multiple test points. Server selection is fully automatic
|
||||
* `example-multipleServers-full.html`: Same as `example-singleServer-full.html` but with multiple test points. Server selection is automatic but the server can be changed afterwards by the user
|
||||
* `example-multipleServers-full.html`: Same as default `index.html` but with multiple test points. Server selection is automatic but the server can be changed afterwards by the user
|
||||
|
||||
### Initialization
|
||||
To use the speed test in your page, first you need to load it:
|
||||
|
|
|
|||
|
|
@ -139,3 +139,10 @@ This command starts LibreSpeed in frontend mode, with a given `servers.json` fil
|
|||
```
|
||||
docker run -e MODE=frontend -e TELEMETRY=true -e ENABLE_ID_OBFUSCATION=true -e PASSWORD="yourPasswordHere" -v $(pwd)/servers.json:/servers.json -p 80:80 -it ghcr.io/librespeed/speedtest
|
||||
```
|
||||
|
||||
### Dual mode
|
||||
In dual mode, LibreSpeed operates as a standalone server that can also connect to other test points.
|
||||
To do this:
|
||||
* Set the `MODE` environment variable to `dual`
|
||||
* Follow the `servers.json` instructions for the frontend mode
|
||||
* The first server entry should be the local server, using the server endpoint address that a client can access.
|
||||
|
|
@ -13,7 +13,7 @@ cp /speedtest/*.js /var/www/html/
|
|||
cp /speedtest/favicon.ico /var/www/html/
|
||||
|
||||
# Set up backend side for standlone modes
|
||||
if [ "$MODE" == "standalone" ]; then
|
||||
if [[ "$MODE" == "standalone" || "$MODE" == "dual" ]]; then
|
||||
cp -r /speedtest/backend/ /var/www/html/backend
|
||||
if [ ! -z "$IPINFO_APIKEY" ]; then
|
||||
sed -i s/\$IPINFO_APIKEY\ =\ \'\'/\$IPINFO_APIKEY\ =\ \'$IPINFO_APIKEY\'/g /var/www/html/backend/getIP_ipInfo_apikey.php
|
||||
|
|
@ -28,14 +28,14 @@ if [ "$MODE" == "backend" ]; then
|
|||
fi
|
||||
|
||||
# Set up index.php for frontend-only or standalone modes
|
||||
if [ "$MODE" == "frontend" ]; then
|
||||
if [[ "$MODE" == "frontend" || "$MODE" == "dual" ]]; then
|
||||
cp /speedtest/frontend.php /var/www/html/index.php
|
||||
elif [ "$MODE" == "standalone" ]; then
|
||||
cp /speedtest/standalone.php /var/www/html/index.php
|
||||
fi
|
||||
|
||||
# Apply Telemetry settings when running in standalone or frontend mode and telemetry is enabled
|
||||
if [[ "$TELEMETRY" == "true" && ( "$MODE" == "frontend" || "$MODE" == "standalone" ) ]]; then
|
||||
if [[ "$TELEMETRY" == "true" && ( "$MODE" == "frontend" || "$MODE" == "standalone" || "$MODE" == "dual" ) ]]; then
|
||||
cp -r /speedtest/results /var/www/html/results
|
||||
|
||||
if [ "$MODE" == "frontend" ]; then
|
||||
|
|
|
|||
Loading…
Reference in a new issue