Eclectic Media Git auto_bandwidth_test / 0797ed8
Added a super simple Readme Ariana Giroux 11 months ago
1 changed file(s) with 23 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
0 On the client side:
1
2 First, obtain a JWT key from the server administrator, and place it in the base directory at path './mykey'
3
4 Second, execute './bin/test.sh'.
5
6 WARNING: The test script will fail if it does not find a JWT key at './mykey'
7
8 This script will automatically handle all dependencies (under 1MB of packages), automatically determine the host IP, perform the bandwidth test, and report it back to the server via a secured REST api.
9
10
11
12 On the server side:
13
14 After installing all requirements (w/ 'pip install -r requirements.txt'), follow these steps from the base path of this repository.
15
16 First, configure iperf to run on port 8028 (package default) and daemonize it (typically via cron/supervisord).
17
18 Second, generate a JWT key for authorization. By default, it will generate a key at './mykey'. The API looks for this file from its current working directory.
19
20 NOTE: This is the file you should distribute to end users!
21
22 Third, daemonize the API bound to host 0.0.0.0 and port 8029! Typically, you would use a service or supervisord to achieve this.