You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Speedtest Android template allows you to configure and distribute an Android app that performs a speedtest using your existing [HTML5 Speedtest](https://github.com/adolfintel/speedtest) server(s).
3
+
# LibreSpeed Android Template
4
+
The Speedtest Android template allows you to configure and distribute an Android app that performs a speedtest using your existing [LibreSpeed](https://github.com/librespeed/speedtest) server(s).
5
5
6
6
The template is easy to configure, customize and distribute.
7
7
@@ -23,10 +23,10 @@ Android 4.0.3 and up (SDK 15), all architectures.
Copy file name to clipboardExpand all lines: doc.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
# Speedtest Android template
1
+
# LibreSpeed Android template
2
2
3
-
The Speedtest Android template allows you to configure and distribute an Android app that performs a speedtest using your existing [HTML5 Speedtest](https://github.com/adolfintel/speedtest) server(s).
3
+
The LibreSpeed Android template allows you to configure and distribute an Android app that performs a speedtest using your existing [LibreSpeed](https://github.com/librespeed/speedtest) server(s).
4
4
5
5
## Configuring the template
6
6
Here's an overview of the structure of the template, configured with the default settings. Click to expand.
7
7
8
-
[](https://github.com/adolfintel/speedtest-android/blob/master/.github/template_fsm.png?raw=true)
8
+
[](https://github.com/librespeed/speedtest-android/blob/master/.github/template_fsm.png?raw=true)
9
9
10
10
### Download the template
11
11
The first thing to do is download latest version of the template:
Now you will have a directory containing the template project and some documentation. Open the Speedtest-Android project in Android Studio.
@@ -52,7 +52,7 @@ Expand app > assets and open ServerList.json. Here you will find a list of test
52
52
53
53
Here's a more in-depth explanation of what the individual fields for each servers are:
54
54
* __`"name"`__: User friendly name (eg. `"Milan, Italy"`)
55
-
* __`"server"`__: URL to the server where HTML5 Speedtest is installed. If it only supports HTTP or HTTPS, specify it; if it supports both, simply use // followed by the address
55
+
* __`"server"`__: URL to the server where LibreSpeed is installed. If it only supports HTTP or HTTPS, specify it; if it supports both, simply use // followed by the address
56
56
* __`"dlURL"`__: Path on your server where the download test can be performed (typically `"garbage.php"` or `"backend/garbage.php"`)
57
57
* __`"urURL"`__: Path on your server where the upload test can be performed (typically `"empty.php"` or `"backend/empty.php"`)
58
58
* __`"pingURL"`__: Path on your server where the ping/jitter test can be performed (typically `"empty.php"` or `"backend/empty.php"`)
@@ -61,7 +61,7 @@ Here's a more in-depth explanation of what the individual fields for each server
61
61
__Important__: This app DOES NOT handle HTTP redirects (3xx codes)!
62
62
63
63
### Telemetry and results sharing
64
-
If you want to enable telemetry and results sharing, edit TelemetryConfig.json. Here you need to add the information about your telemetry server (HTML5 Speedtest frontend server). This feature is disabled by default.
64
+
If you want to enable telemetry and results sharing, edit TelemetryConfig.json. Here you need to add the information about your telemetry server (LibreSpeed frontend server). This feature is disabled by default.
65
65
66
66
* Follow this syntax:
67
67
```json
@@ -81,7 +81,7 @@ Here's a more in-depth explanation of what the individual fields are:
81
81
*`"basic"`: Stores results for completed tests without log
82
82
*`"full"`: Stores results and log for all tests, even if they are aborted or if they fail
83
83
* Default: `"disabled"`
84
-
*__`"server"`__: URL to the server where the HTML5 Speedtest telemetry is installed (the frontend server). If it only supports HTTP or HTTPS, specify it; if it supports both, simply use // followed by the address
84
+
*__`"server"`__: URL to the server where the LibreSpeed telemetry is installed (the frontend server). If it only supports HTTP or HTTPS, specify it; if it supports both, simply use // followed by the address
85
85
*__`"path"`__: Path on your server where telemetry can be stored (typically `results/telemetry.php`)
86
86
*__`"shareURL"`__: Path on your server where the results sharing links point to (typically `results/?id=%s` or an empty string if you don't want to enable this feature). %s will be replaced by the test ID. Omit this if you don't want to use results sharing
87
87
@@ -262,7 +262,7 @@ Here's a description of each string:
262
262
*__`privacy_close`__: Text of the link that closes the privacy policy
263
263
264
264
### The end
265
-
Your template is now fully configured for your HTML5 Speedtest server(s). Enjoy!
265
+
Your template is now fully configured for your LibreSpeed server(s). Enjoy!
266
266
267
267
This template is licensed under the [GNU LGPLv3 License](https://www.gnu.org/licenses/lgpl-3.0.en.html). In short, you are free to use, study, modify, and distribute modified copies of this application, but they must remain under the same GNU LGPLv3 license. This means that if you make any modification to the application, the source code must be made publicly available. Merely changing the configuration of this template as we did in this chapter does NOT count as a modified version, so you are free to distribute it as an APK, but any other change made to the app does count as a modification and you MUST provide the source code.
268
268
@@ -419,7 +419,7 @@ Note: aborting the test is not instantaneous. This is done asynchronously. If th
419
419
## Implementation details
420
420
This chapter is dedicated to the inner workings of the `com.fdossena.speedtest.core` package. You don't need to read this section if you're just customizing the template or making a custom UI, it's only here if you need to make changes to how the speedtest client works.
421
421
422
-
If you also need to know how the speedtest server works, see [here](https://github.com/adolfintel/speedtest/wiki/Implementation-details).
422
+
If you also need to know how the speedtest server works, see [here](https://github.com/librespeed/speedtest/wiki/Implementation-details).
423
423
424
424
__Remember that both the server and this client are under a GNU LGPLv3 license, so any modification you make to it MUST be publicly available in source form! No exceptions.__
*`name`: User friendly name (eg. `"Milan, Italy"`)
728
-
*`server`: URL to the server where HTML5 Speedtest is installed. If it only supports HTTP or HTTPS, specify it; if it supports both, simply use // followed by the address
728
+
*`server`: URL to the server where LibreSpeed is installed. If it only supports HTTP or HTTPS, specify it; if it supports both, simply use // followed by the address
729
729
*`dlURL`: Path on your server where the download test can be performed (typically `"garbage.php"` or `"backend/garbage.php"`)
730
730
*`urURL`: Path on your server where the upload test can be performed (typically `"empty.php"` or `"backend/empty.php"`)
731
731
*`pingURL`: Path on your server where the ping/jitter test can be performed (typically `"empty.php"` or `"backend/empty.php"`)
0 commit comments