Updated doc.md
This commit is contained in:
parent
bfe80d9fb9
commit
42537b4e23
60
doc.md
60
doc.md
|
@ -1,7 +1,7 @@
|
|||
# LibreSpeed
|
||||
|
||||
> by Federico Dossena
|
||||
> Version 5.1
|
||||
> Version 5.2
|
||||
> [https://github.com/librespeed/speedtest/](https://github.com/librespeed/speedtest/)
|
||||
|
||||
## Introduction
|
||||
|
@ -156,32 +156,32 @@ Edit `index.html`, you will see a list of servers:
|
|||
```js
|
||||
var SPEEDTEST_SERVERS=[
|
||||
{
|
||||
name:"Speedtest Demo Server 1", //user friendly name for the server
|
||||
server:"//mpotdemo.fdossena.com/", //URL to the server. // at the beginning will be replaced with http:// or https:// automatically
|
||||
dlURL:"garbage.php", //path to download test on this server (garbage.php or replacement)
|
||||
ulURL:"empty.php", //path to upload test on this server (empty.php or replacement)
|
||||
pingURL:"empty.php", //path to ping/jitter test on this server (empty.php or replacement)
|
||||
getIpURL:"getIP.php" //path to getIP on this server (getIP.php or replacement)
|
||||
"name":"Speedtest Demo Server 1", //user friendly name for the server
|
||||
"server":"//mpotdemo.fdossena.com/", //URL to the server. // at the beginning will be replaced with http:// or https:// automatically
|
||||
"dlURL":"garbage.php", //path to download test on this server (garbage.php or replacement)
|
||||
"ulURL":"empty.php", //path to upload test on this server (empty.php or replacement)
|
||||
"pingURL":"empty.php", //path to ping/jitter test on this server (empty.php or replacement)
|
||||
"getIpURL":"getIP.php" //path to getIP on this server (getIP.php or replacement)
|
||||
},
|
||||
{
|
||||
name:"Speedtest Demo Server 2",
|
||||
server:"//mpotdemo2.fdossena.com/",
|
||||
dlURL:"garbage.php",
|
||||
ulURL:"empty.php",
|
||||
pingURL:"empty.php",
|
||||
getIpURL:"getIP.php"
|
||||
"name":"Speedtest Demo Server 2",
|
||||
"server":"//mpotdemo2.fdossena.com/",
|
||||
"dlURL":"garbage.php",
|
||||
"ulURL":"empty.php",
|
||||
"pingURL":"empty.php",
|
||||
"getIpURL":"getIP.php"
|
||||
}
|
||||
//add other servers here, comma separated
|
||||
];
|
||||
```
|
||||
|
||||
Replace the demo servers with your test points. Each server in the list is an object containing:
|
||||
* `name`: user friendly name for this test point
|
||||
* `server`: URL to the server. If your server only supports HTTP or HTTPS, put http:// or https:// at the beginning, respectively; if it supports both, put // at the beginning and it will be replaced automatically
|
||||
* `dlURL`: path to the download test on this server (garbage.php or replacement)
|
||||
* `ulURL`: path to the upload test on this server (empty.php or replacement)
|
||||
* `pingURL`: path to the ping test on this server (empty.php or replacement)
|
||||
* `getIpURL`: path to getIP on this server (getIP.php or replacement)
|
||||
* `"name"`: user friendly name for this test point
|
||||
* `"server"`: URL to the server. If your server only supports HTTP or HTTPS, put http:// or https:// at the beginning, respectively; if it supports both, put // at the beginning and it will be replaced automatically
|
||||
* `"dlURL"`: path to the download test on this server (garbage.php or replacement)
|
||||
* `"ulURL"`: path to the upload test on this server (empty.php or replacement)
|
||||
* `"pingURL"`: path to the ping test on this server (empty.php or replacement)
|
||||
* `"getIpURL"`: path to getIP on this server (getIP.php or replacement)
|
||||
|
||||
None of these parameters can be omitted.
|
||||
|
||||
|
@ -191,6 +191,23 @@ __Important__: For HTTPS, all your servers must have valid certificates or the b
|
|||
|
||||
__Important__: Don't use my demo servers, they're slow!
|
||||
|
||||
If your list of servers changes often, you might not want to have it hardcoded in the HTML file. LibreSpeed can load the server list from a JSON file. To do this, edit `index.html` and replace the list of servers with this:
|
||||
```js
|
||||
var SPEEDTEST_SERVERS="your URL here";
|
||||
```
|
||||
|
||||
The URL doesn't need to be complete, it can just point to a file in the current directory. The URL should point to a JSON file with the same format used above:
|
||||
```js
|
||||
[
|
||||
{
|
||||
"name":...
|
||||
},
|
||||
...
|
||||
]
|
||||
```
|
||||
|
||||
__Important:__ The same origin policy applies to which URLs you can and cannot load with this method. If possible, it's best to just point it to a file on the current server.
|
||||
|
||||
##### Telemetry and results sharing
|
||||
Telemetry is stored on the frontend server. The setup procedure is the same as the single server version.
|
||||
|
||||
|
@ -535,6 +552,11 @@ Note that this will add `mpot`:`true` to the parameters sent to the speedtest wo
|
|||
##### addTestPoints(list)
|
||||
Same as addTestPoint, but you can pass an array of servers
|
||||
|
||||
##### loadServerList(url,result)
|
||||
Loads a list of servers from a JSON file pointed by the `url`.
|
||||
|
||||
The process is asynchronous and the `result` function will be called when it's done. If the request succeeded, an array containing the list of loaded servers will be passed to the function, otherwise `null` will be passed.
|
||||
|
||||
##### getSelectedServer()
|
||||
Returns the selected server (multiple points of test)
|
||||
|
||||
|
|
Loading…
Reference in a new issue