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
Copy file name to clipboardExpand all lines: README.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,22 +12,21 @@ experience is poor, good or great
12
12
For deploying to a test server, see the README under **ansible** folder.
13
13
14
14
15
-
##Client Server Setup
15
+
##Client Server Setup
16
16
The application consists of a node/express software running the server and plain javascript/html on the client. The server
17
17
powers reset endpoints, websocket communication, database interactions and the client website.
18
18
19
-
#Server
19
+
#Server
20
20
Index.js is the starting point of the app contains of the neccessary functions to run the application. Significant
21
21
settings in this file are:
22
22
23
-
* Ip address and ports: the server will automatically bind to the ipv4 and ipv6 addresses of the host machine that it is deployed
24
-
to (ie. app.listen(SERVERPORT,'::');). Addtionaly ports can be assigned with app.listen(ADDITIONALPORT);
23
+
* IP address and ports: the server will automatically bind to the ipv4 and ipv6 addresses of the host machine that it is deployed to (ie. app.listen(SERVERPORT,'::');). Addtionaly ports can be assigned with app.listen(ADDITIONALPORT);
25
24
26
25
* Http Request: http configuration is defined to allow http posts and cross domain request.
27
26
28
27
* WebSockets: websockets communication is defined
29
28
30
-
*Rest endPoints: rest endpoints are exposed to complete a speed test and include the following:
29
+
*REST endpoints: rest endpoints are exposed to complete a speed test and include the following:
31
30
1. testplan: testplan will return json data containing the ipv4, ipv6 ipaddresses and ports used for rest endPoints
32
31
and websockets running on the server and the client ipAddress. Also additional speed test features(ie. latency based
33
32
routing flags can be returned)
@@ -39,7 +38,7 @@ to (ie. app.listen(SERVERPORT,'::');). Addtionaly ports can be assigned with app
39
38
7. testServer: used in latency based routing.. it will return test servers urls that can
40
39
be used to find the closet server to a client
41
40
42
-
* Configuration: Generic configuration(ports, latencyBasedRouting,...) are set in index.js. Specific customization(ie. database)
41
+
* Configuration: Generic configuration(ports, latencyBasedRouting,...) are set in index.js. Specific customization(ie. database)
43
42
can be place under the config folder
44
43
45
44
1. Configuration parameters
@@ -49,8 +48,8 @@ to (ie. app.listen(SERVERPORT,'::');). Addtionaly ports can be assigned with app
49
48
50
49
# Client
51
50
52
-
Client: Client application resides under the public folder and consists of plain javascript. Index.html is the
53
-
default start page of the application and will contain an end to end example of aBandwidth Speed Test. The following describes
51
+
Client: Client application resides in the public folder and consists of plain javascript. Index.html is the
52
+
default start page of the application and will contain an end to end example of a Bandwidth Speed Test. The following describes
54
53
the folder structure of the client application:
55
54
56
55
* lib: The lib folder contains javascript files used to measure bandwidth and related measurements.
0 commit comments