GITBOOK-1: No subject

Author: svenvg93

SUMMARY.md

@@ -38,6 +38,7 @@
 
 ## 👀 Other
 
+* [Speedtest Process](other/speedtest-process.md)
 * [Proxies](other/proxies/README.md)
   * [Cloudflare Tunnel (Zero Trust)](other/proxies/cloudflare-tunnel-zero-trust.md)
   * [Traefik](other/proxies/traefik.md)

other/speedtest-process.md

@@ -0,0 +1,57 @@
+# Speedtest Process
+
+Speedtest Tracker uses the [Official Ookla CLI](https://www.speedtest.net/apps/cli) client to execute the speedtest. There a couple of stages the Speedtest Tracker goes through, below explains the process. 
+
+{% stepper %}
+{% step %}
+### Started
+
+The Speedtest process is started
+{% endstep %}
+
+{% step %}
+### Checking
+
+The application checks for an internet connection by calling `https://icanhazip.com`
+{% endstep %}
+
+{% step %}
+### Skipped \[Optional]
+
+If you have the `SPEEDTEST_SKIP_IPS`  the test will be marked as skipped as the IP returning during `Checking`  matches your defined IP.
+{% endstep %}
+
+{% step %}
+### Running
+
+The application runs the speedtest by simply running the speedtest command. This command runs the speedtest like another other speedtest and returns the result in json format so the application an easily process it. 
+
+```
+speedtest -accept-license --accept-gdpr --format=json
+```
+
+Or when you have defined a server id:
+
+```
+speedtest -accept-license --accept-gdpr --format=json --server-id=YOURSERVERID
+```
+{% endstep %}
+
+{% step %}
+### Failed
+
+If for various reasons the Ookla CLI returns an error, because the defined server was offline for example the tests is marked as failed. As well when the `Checking` stage fails when there is no internet. 
+{% endstep %}
+
+{% step %}
+### Benchmarking
+
+When you have thresholds set this step will evaluate the results against the threshold to determine if the test was healthy or not.
+{% endstep %}
+
+{% step %}
+### Completed
+
+This is the end stage of the process when every step is completed the test is marked as such. 
+{% endstep %}
+{% endstepper %}