Skip to content

Commit a03e513

Browse files
alexjustesengitbook-bot
authored andcommitted
GITBOOK-87: change request with no subject merged in GitBook
1 parent a0704c5 commit a03e513

File tree

4 files changed

+5
-27
lines changed

4 files changed

+5
-27
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: >-
77
# Introduction
88

99
{% hint style="info" %}
10-
Docs are up to date through version: `0.19.x`
10+
Docs are up to date through version: `0.20.x`
1111
{% endhint %}
1212

1313
<figure><img src=".gitbook/assets/dashboard_screenshot.jpg" alt=""><figcaption></figcaption></figure>

changelog.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,3 @@ description: Important milestones in the project.
88
A complete history of all changes can be found on GitHub in the [releases](https://github.com/alexjustesen/speedtest-tracker/releases).
99
{% endhint %}
1010

11-
### 2024
12-
13-
#### Feb. 19th, 2024 - Data Quality Release
14-
15-
`v0.16.0` fixes a hand full of data quality issues that have been around for a while and also adds some nice new features like a more robust export method and automatic pruning of older results.
16-
17-
Read more: [https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.16.0](https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.16.0)
18-
19-
#### Feb. 9th, 2024 - LinuxServer.io Docker image now available!
20-
21-
The fantastic gents over at [LinuxServer.io](https://www.linuxserver.io/) have build an [image](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker) that is 3-4x faster and 1/2 the build size of the current image! For more details check out the published [issue](https://github.com/alexjustesen/speedtest-tracker/issues/1117) on GitHub.
22-
23-
***
24-
25-
### 2023
26-
27-
🤷‍♂️ I did a lot, just haven't filled this in yet.
28-
29-
***
30-
31-
### 2022
32-
33-
#### Sep. 13th, 2022 - First release!
34-
35-
Where it all [started](https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.1.0-alpha.1).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Environment Variables
22

3-
<table><thead><tr><th width="225">Name</th><th>Description</th></tr></thead><tbody><tr><td><code>PUID</code><br><br>(required)</td><td>Used to set the user the container should run as.<br><br>- Default:<code>1000</code></td></tr><tr><td><code>PGID</code><br><br>(required)</td><td>Used to set the group the container should run as.<br><br>- Default:<code>1000</code></td></tr><tr><td><code>APP_NAME</code></td><td>Used to define the application's name in the dashboard and in notifications.<br><a href="../../help/faqs.md#i-get-a-warning-on-container-start-up-that-the-app_key-is-missing">FAQ</a></td></tr><tr><td><code>APP_KEY</code></td><td><p>Key used to encrypt and decrypt data. To create your own key to persist run<code>php artisan key:generate --show</code>from within the running container.</p><p></p><p>Make sure to include the prepended<code>base64:</code>prefix.</p></td></tr><tr><td><code>CONTENT_WIDTH</code></td><td>Width of the content section of each page. Can be set to any value found in the Filament<a href="https://filamentphp.com/docs/3.x/panels/configuration#customizing-the-maximum-content-width">docs</a>.<br><br>- Default:<code>7xl</code></td></tr><tr><td><code>PUBLIC_DASHBOARD</code></td><td>Enables the public dashboard for guest (unauthenticated) users.<br><br>- Default:<code>false</code></td></tr><tr><td><code>DASHBOARD_POLLING</code></td><td>Frequency charts and stats refresh on the dashboard. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>60s</code></td></tr><tr><td><code>NOTIFICATION_POLLING</code></td><td>Frequency database notifications are polled. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>60s</code></td></tr><tr><td><code>RESULTS_POLLING</code></td><td>Frequency data refreshes in the results table. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>false</code></td></tr><tr><td><code>MAIL_ENCRYPTION</code></td><td>Mail encryption used for sending test results and notifications trough email.<br>Can be<code>ssl</code>or<code>tls</code><br></td></tr><tr><td><code>MAIL_FROM_ADDRESS</code></td><td>Email address used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_FROM_NAME</code></td><td>Name used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_HOST</code></td><td>SMTP server used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_MAILER</code></td><td>Email protocol used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_PASSWORD</code></td><td>SMTP password from email address used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_PORT</code></td><td>SMTP port from email server used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_USERNAME</code></td><td>Username from SMTP server used for sending test results and notifications trough email.</td></tr><tr><td><code>TZ</code></td><td>Time zone used to get the date and time of tests</td></tr><tr><td><code>APP_URL</code></td><td>URL used on emails sent.<br>That URL is the one that appears on links that are sent trough email<a href="../../help/faqs#notifications">FAQ</a></td></tr></tbody></table>
3+
<table><thead><tr><th width="225">Name</th><th>Description</th></tr></thead><tbody><tr><td><code>PUID</code><br><br>(required)</td><td>Used to set the user the container should run as.<br><br>- Default:<code>1000</code></td></tr><tr><td><code>PGID</code><br><br>(required)</td><td>Used to set the group the container should run as.<br><br>- Default:<code>1000</code></td></tr><tr><td><code>APP_NAME</code></td><td>Used to define the application's name in the dashboard and in notifications.<br><a href="../help/faqs.md#i-get-a-warning-on-container-start-up-that-the-app_key-is-missing">FAQ</a></td></tr><tr><td><code>APP_KEY</code></td><td><p>Key used to encrypt and decrypt data. </p><p></p><p>You can generate a key at <a href="https://speedtest-tracker.dev">https://speedtest-tracker.dev</a>.</p></td></tr><tr><td><code>CONTENT_WIDTH</code></td><td>Width of the content section of each page. Can be set to any value found in the Filament<a href="https://filamentphp.com/docs/3.x/panels/configuration#customizing-the-maximum-content-width">docs</a>.<br><br>- Default:<code>7xl</code></td></tr><tr><td><code>PUBLIC_DASHBOARD</code></td><td>Enables the public dashboard for guest (unauthenticated) users.<br><br>- Default:<code>false</code></td></tr><tr><td><code>DASHBOARD_POLLING</code></td><td>Frequency charts and stats refresh on the dashboard. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>60s</code></td></tr><tr><td><code>NOTIFICATION_POLLING</code></td><td>Frequency database notifications are polled. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>60s</code></td></tr><tr><td><code>RESULTS_POLLING</code></td><td>Frequency data refreshes in the results table. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>false</code></td></tr><tr><td><code>MAIL_ENCRYPTION</code></td><td>Mail encryption used for sending test results and notifications trough email.<br>Can be<code>ssl</code>or<code>tls</code><br></td></tr><tr><td><code>MAIL_FROM_ADDRESS</code></td><td>Email address used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_FROM_NAME</code></td><td>Name used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_HOST</code></td><td>SMTP server used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_MAILER</code></td><td>Email protocol used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_PASSWORD</code></td><td>SMTP password from email address used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_PORT</code></td><td>SMTP port from email server used for sending test results and notifications trough email.</td></tr><tr><td><code>MAIL_USERNAME</code></td><td>Username from SMTP server used for sending test results and notifications trough email.</td></tr><tr><td><code>TZ</code></td><td>Time zone used to get the date and time of tests</td></tr><tr><td><code>APP_URL</code></td><td>Application URL used for assets and links in emails and notifications.</td></tr></tbody></table>

getting-started/installation/qnap.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,15 @@ services:
2626
environment:
2727
- PUID=1000
2828
- PGID=1000
29+
- APP_KEY=
2930
- DB_CONNECTION=mysql
3031
- DB_HOST=192.168.1.4
3132
- DB_PORT=3306
3233
- DB_DATABASE=speedtest_tracker
3334
- DB_USERNAME=speedy
3435
- DB_PASSWORD=password
36+
- SPEEDTEST_SCHEDULE=
37+
- SPEEDTEST_SERVERS=
3538
volumes:
3639
- /path/to-data:/config
3740
- /path/to-custom-ssl-keys:/config/keys

0 commit comments

Comments
 (0)