Skip to content

Commit e3e1362

Browse files
alexjustesengitbook-bot
authored andcommitted
GitBook: No commit message
1 parent 8458ec9 commit e3e1362

File tree

6 files changed

+18
-34
lines changed

6 files changed

+18
-34
lines changed

SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@
4444
* [Traefik](other/proxies/traefik.md)
4545
* [Tailscale](other/proxies/tailscale.md)
4646
* [Nginx](other/proxies/nginx.md)
47-
* [Caching](other/caching.md)
4847
* [Commands](other/commands.md)
4948
* [Data Dictionary](other/data-dictionary.md)
5049
* [Embed Dashboard](other/embed-dashboard.md)

other/caching.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

other/commands.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,10 @@ Core commands exist at the framework level and might be extended to provide addi
2020

2121
Application commands are built to extend Speedtest Tracker's functionality from the CLI.
2222

23-
<table><thead><tr><th width="261">Command</th><th>Description</th></tr></thead><tbody><tr><td><code>app:install</code></td><td>Installs a fresh version of Speedtest Tracker. If you have an existing install <em><strong>this will delete all data</strong></em>.</td></tr><tr><td><code>app:ookla-list-servers</code></td><td>Get a list of local Ookla speedtest servers.</td></tr><tr><td><code>app:user-change-role</code></td><td>Change the role for a user.</td></tr><tr><td><code>app:user-reset-password</code></td><td>Change the password for a user.</td></tr></tbody></table>
23+
<table><thead><tr><th width="261">Command</th><th>Description</th></tr></thead><tbody><tr><td><code>app:ookla-list-servers</code></td><td>Get a list of local Ookla speedtest servers.</td></tr><tr><td><code>app:user-change-role</code></td><td>Change the role for a user.</td></tr><tr><td><code>app:user-reset-password</code></td><td>Change the password for a user.</td></tr></tbody></table>
2424

2525
### Maintenance commands
2626

2727
Maintenance commands help fix issues that might crop up over time.
2828

2929
<table><thead><tr><th width="261">Command</th><th>Description</th></tr></thead><tbody><tr><td><code>app:result-fix-statuses</code></td><td>Reviews the data payload of each result and corrects the status attribute.</td></tr></tbody></table>
30-
31-
32-

other/proxies/cloudflare-tunnel-zero-trust.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Cloudflare Tunnel (Zero Trust)
22

3-
[Cloudflare tunnel ](https://www.cloudflare.com/nl-nl/products/tunnel/)can be used as a Reverse Proxy in front of Speedtest Tracker when you want to expose the Dashboard publicly without exposing your IP Address and with a trusted certificate,You will need at add the `APP_URL` envoirment.
3+
A [Cloudflare tunnel ](https://www.cloudflare.com/nl-nl/products/tunnel/)can be used as a reverse proxy in front of Speedtest Tracker when you want to expose the application publicly without exposing your IP address.
44

55
### Cloudflare Tunnel Configuration
66

7-
* Go to the **Networks** -> **Tunnels** page.
8-
* For the tunnel you want to add the Speedtest Tracker to. Click on **Edit**
9-
* Go to **Public Hostname**
10-
* Click on **Add a public hostname**
11-
* Fill in the fields the following field
7+
* Update your `APP_URL` to the public URL you are going to use and restart the service.
8+
* In the Cloudflare panel go to **Zero Trust** -> **Networks** -> **Tunnels** page.
9+
* For the tunnel you want to add the Speedtest Tracker to click on **Edit** or add a new tunnel.
10+
* Go to **Public Hostname.**
11+
* Click on **Add a public hostname.**
12+
* Fill in the following fields.
1213
* **Subdomain:** The subdomain you want to access the Speedtest Tracker on.
1314
* **Domain:** The domain you want to access the Speedtest Tracker on.
1415
* **Type:** Connection type to the Speedtest Tracker (http/https)

other/speedtest-process.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,31 @@ Speedtest Tracker uses the [Official Ookla CLI](https://www.speedtest.net/apps/c
44

55
{% stepper %}
66
{% step %}
7-
8-
#### Waiting
7+
**Waiting**
98

109
The speedtest run request was created but has not been started.
1110
{% endstep %}
1211

1312
{% step %}
14-
15-
#### Started
13+
**Started**
1614

1715
The speedtest process has been started by a queue worker.
1816
{% endstep %}
1917

2018
{% step %}
21-
#### Checking
19+
**Checking**
2220

23-
The application checks for an internet connection by calling `https://icanhazip.com`
21+
The application checks for an internet connection by calling `https://icanhazip.com` .
2422
{% endstep %}
2523

2624
{% step %}
27-
#### Skipped \[Optional]
25+
**Skipped \[Optional]**
2826

2927
If you have the `SPEEDTEST_SKIP_IPS` the test will be marked as skipped as the IP returning during `Checking` matches your defined IP.
3028
{% endstep %}
3129

3230
{% step %}
33-
#### Running
31+
**Running**
3432

3533
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.
3634

@@ -46,19 +44,19 @@ speedtest -accept-license --accept-gdpr --format=json --server-id=YOURSERVERID
4644
{% endstep %}
4745

4846
{% step %}
49-
#### Failed
47+
**Failed**
5048

5149
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.
5250
{% endstep %}
5351

5452
{% step %}
55-
#### Benchmarking
53+
**Benchmarking**
5654

5755
When you have thresholds set this step will evaluate the results against the threshold to determine if the test was healthy or not.
5856
{% endstep %}
5957

6058
{% step %}
61-
#### Completed
59+
**Completed**
6260

6361
This is the end stage of the process when every step is completed the test is marked as such.
6462
{% endstep %}

security/authorization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
### Other
2525

26-
<table><thead><tr><th width="302"></th><th data-type="checkbox">User</th><th data-type="checkbox">Admin</th></tr></thead><tbody><tr><td>Trigger a manual Speedtest</td><td>false</td><td>true</td></tr></tbody></table>
26+
<table><thead><tr><th width="302"></th><th data-type="checkbox">User</th><th data-type="checkbox">Admin</th></tr></thead><tbody><tr><td>Manage API tokens</td><td>false</td><td>true</td></tr><tr><td>Trigger a manual Speedtest</td><td>false</td><td>true</td></tr></tbody></table>
2727

2828
***
2929

0 commit comments

Comments
 (0)