Skip to content

Commit 5abab9b

Browse files
svenvg93gitbook-bot
svenvg93
authored and
gitbook-bot
committed
GITBOOK-5: No subject
1 parent 743b789 commit 5abab9b

File tree

5 files changed

+47
-196
lines changed

5 files changed

+47
-196
lines changed

‎SUMMARY.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
## 🚀 Getting Started
88

99
* [Installation](getting-started/installation.md)
10-
* [Copy of Installation](getting-started/installation-1.md)
1110
* [Environment Variables](getting-started/environment-variables.md)
1211
* [Database Drivers](getting-started/database-drivers.md)
1312

‎getting-started/environment-variables.md‎

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

99
### Application
1010

11-
<table><thead><tr><th width="218">Name</th><th width="103" data-type="checkbox">Required</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>PUID</code></td><td>true</td><td>Used to set the user the container should run as.</td><td><code>1000</code></td></tr><tr><td><code>PGID</code></td><td>true</td><td>Used to set the group the container should run as.</td><td><code>1000</code></td></tr><tr><td><code>APP_NAME</code></td><td>false</td><td>Used to define the application's name in the dashboard and in notifications.<br></td><td></td></tr><tr><td><code>APP_KEY</code></td><td>true</td><td><p>Key used to encrypt and decrypt data.</p><p>You can generate a key at <a href="https://speedtest-tracker.dev">https://speedtest-tracker.dev</a>.</p></td><td><code>base64:ZoOYTjS+LBwFtud8SArwhiw8V4Qi9J+MPiT7z8XjfMo=</code><br>(DONT USE THIS EXAMPLE)</td></tr><tr><td><code>APP_URL</code></td><td>false</td><td>URL used for links in emails and notifications.</td><td><code>https://speedtest.example.com</code></td></tr><tr><td><code>ASSET_URL</code></td><td>false</td><td>URL used for assets, needed when using a reverse proxy.</td><td><code>https://speedtest.example.com</code></td></tr><tr><td><code>APP_TIMEZONE</code></td><td>false</td><td>Application timezone should be set if your database does not use UTC as its default timezone.</td><td><code>Europe/London</code></td></tr><tr><td><code>CHART_BEGIN_AT_ZERO</code></td><td>false</td><td>Begin the dashboard axis charts at zero.<br><br>- Default: <code>true</code></td><td><code>true</code> or <code>false</code></td></tr><tr><td><code>CHART_DATETIME</code><br><code>_FORMAT</code></td><td>false</td><td>Set the formatting of timestamps in charts.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td><td><code>j/m G:i</code><br>(18/10 20:06)</td></tr><tr><td><code>DATETIME_FORMAT</code></td><td>false</td><td>Set the formatting of timestamps in tables and notifications.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td><td><code>j M Y, G:i:s</code><br>(18 Oct 2024, 20:06:01)</td></tr><tr><td><code>DISPLAY_TIMEZONE</code></td><td>false</td><td>Display timestamps in your local time.</td><td><code>Europe/London</code></td></tr><tr><td><code>CONTENT_WIDTH</code></td><td>false</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><td></td></tr><tr><td><code>PUBLIC_DASHBOARD</code></td><td>false</td><td>Enables the public dashboard for guest (unauthenticated) users.<br><br>- Default:<code>false</code></td><td></td></tr><tr><td><code>DASHBOARD_POLLING</code></td><td>false</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><td></td></tr><tr><td><code>NOTIFICATION</code><br><code>_POLLING</code></td><td>false</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><td></td></tr><tr><td><code>RESULTS_POLLING</code></td><td>false</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><td></td></tr></tbody></table>
11+
<table><thead><tr><th width="218">Name</th><th width="103" data-type="checkbox">Required</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>PUID</code></td><td>true</td><td>Used to set the user the container should run as.</td><td><code>1000</code></td></tr><tr><td><code>PGID</code></td><td>true</td><td>Used to set the group the container should run as.</td><td><code>1000</code></td></tr><tr><td><code>APP_NAME</code></td><td>false</td><td>Used to define the application's name in the dashboard and in notifications.<br></td><td></td></tr><tr><td><code>APP_KEY</code></td><td>true</td><td><p>Key used to encrypt and decrypt data.</p><p>You can generate a key at <a href="https://speedtest-tracker.dev">https://speedtest-tracker.dev</a>.</p></td><td><code>base64:ZoOYTjS+LBwFtud8SArwhiw8V4Qi9J+MPiT7z8XjfMo=</code><br>(DONT USE THIS EXAMPLE)</td></tr><tr><td><code>APP_URL</code></td><td>false</td><td>URL used for links in emails and notifications.</td><td><code>https://speedtest.example.com</code></td></tr><tr><td><code>ASSET_URL</code></td><td>false</td><td>URL used for assets, needed when using a reverse proxy.</td><td><code>https://speedtest.example.com</code></td></tr><tr><td><code>APP_TIMEZONE</code></td><td>true</td><td>Application timezone should be set if your database does not use UTC as its default timezone.</td><td><code>Europe/London</code></td></tr><tr><td><code>CHART_BEGIN_AT_ZERO</code></td><td>false</td><td>Begin the dashboard axis charts at zero.<br><br>- Default: <code>true</code></td><td><code>true</code> or <code>false</code></td></tr><tr><td><code>CHART_DATETIME</code><br><code>_FORMAT</code></td><td>false</td><td>Set the formatting of timestamps in charts.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td><td><code>j/m G:i</code><br>(18/10 20:06)</td></tr><tr><td><code>DATETIME_FORMAT</code></td><td>true</td><td>Set the formatting of timestamps in tables and notifications.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td><td><code>j M Y, G:i:s</code><br>(18 Oct 2024, 20:06:01)</td></tr><tr><td><code>DISPLAY_TIMEZONE</code></td><td>false</td><td>Display timestamps in your local time.</td><td><code>Europe/London</code></td></tr><tr><td><code>CONTENT_WIDTH</code></td><td>false</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><td></td></tr><tr><td><code>PUBLIC_DASHBOARD</code></td><td>false</td><td>Enables the public dashboard for guest (unauthenticated) users.<br><br>- Default:<code>false</code></td><td></td></tr><tr><td><code>DASHBOARD_POLLING</code></td><td>false</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><td></td></tr><tr><td><code>NOTIFICATION</code><br><code>_POLLING</code></td><td>false</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><td></td></tr><tr><td><code>RESULTS_POLLING</code></td><td>false</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><td></td></tr></tbody></table>
1212

1313
### Speedtest
1414

‎getting-started/installation-1.md‎

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

‎getting-started/installation.md‎

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,19 @@ description: >-
66

77
# Installation
88

9-
These steps will run you through setting up the application using Docker and Docker Compose.
9+
Setting up your environment with Docker Compose is the recommended way as it'll setup the application and a database for you. These steps will run you through setting up the application using Docker and Docker Compose.
1010

1111
### Install with Docker
1212

13-
#### Docker Compose
13+
{% stepper %}
14+
{% step %}
15+
### Docker Compose
1416

15-
Setting up your environment with Docker Compose is the recommended way as it'll setup the application and a database for you. SQLite is fine for most installs but we also provide instructions for setting up MariaDB, MySQL and Postgres should you prefer those database drivers.
17+
SQLite is fine for most installs but we also provide instructions for setting up MariaDB, MySQL and Postgres should you prefer those database drivers.
1618

19+
{% hint style="info" %}
1720
If you would like to provide your own SSL keys, they must be named `cert.crt` (full chain) and `cert.key` (private key), and mounted in the container folder `/config/keys`.
21+
{% endhint %}
1822

1923
{% tabs %}
2024
{% tab title="SQLite" %}
@@ -30,12 +34,12 @@ services:
3034
environment:
3135
- PUID=1000
3236
- PGID=1000
33-
- APP_KEY=
3437
- DB_CONNECTION=sqlite
35-
- SPEEDTEST_SCHEDULE= # Optional
36-
- SPEEDTEST_SERVERS= # Optional
38+
- APP_KEY=
3739
- DATETIME_FORMAT=
3840
- APP_TIMEZONE=
41+
- SPEEDTEST_SCHEDULE= # Optional
42+
- SPEEDTEST_SERVERS= # Optional
3943
volumes:
4044
- /path/to/data:/config
4145
- /path/to-custom-ssl-keys:/config/keys
@@ -56,19 +60,17 @@ services:
5660
environment:
5761
- PUID=1000
5862
- PGID=1000
59-
- APP_KEY=
6063
- DB_CONNECTION=mysql
6164
- DB_HOST=db
6265
- DB_PORT=3306
6366
- DB_DATABASE=speedtest_tracker
6467
- DB_USERNAME=speedy
6568
- DB_PASSWORD=password
66-
- SPEEDTEST_SCHEDULE=
67-
- SPEEDTEST_SERVERS=
68-
- PRUNE_RESULTS_OLDER_THAN=
69-
- CHART_DATETIME_FORMAT=
69+
- APP_KEY=
7070
- DATETIME_FORMAT=
7171
- APP_TIMEZONE=
72+
- SPEEDTEST_SCHEDULE= # Optional
73+
- SPEEDTEST_SERVERS= # Optional
7274
volumes:
7375
- /path/to/data:/config
7476
- /path/to-custom-ssl-keys:/config/keys
@@ -102,19 +104,17 @@ services:
102104
environment:
103105
- PUID=1000
104106
- PGID=1000
105-
- APP_KEY=
106107
- DB_CONNECTION=pgsql
107108
- DB_HOST=db
108-
- DB_PORT=5432
109+
- DB_PORT=3306
109110
- DB_DATABASE=speedtest_tracker
110111
- DB_USERNAME=speedy
111112
- DB_PASSWORD=password
112-
- SPEEDTEST_SCHEDULE=
113-
- SPEEDTEST_SERVERS=
114-
- PRUNE_RESULTS_OLDER_THAN=
115-
- CHART_DATETIME_FORMAT=
113+
- APP_KEY=
116114
- DATETIME_FORMAT=
117115
- APP_TIMEZONE=
116+
- SPEEDTEST_SCHEDULE= # Optional
117+
- SPEEDTEST_SERVERS= # Optional
118118
volumes:
119119
- /path/to/data:/config
120120
- /path/to-custom-ssl-keys:/config/keys
@@ -134,18 +134,32 @@ volumes:
134134
```
135135
{% endtab %}
136136
{% endtabs %}
137+
{% endstep %}
137138
138-
#### Setting Environment Variables
139+
{% step %}
140+
#### Environment Variables
139141
140-
In order for the application to run smoothly, some environment variables need to be test. &#x20;
142+
In order for the application to run smoothly, some environment variables need to be test. Check out the [Environment Variables](environment-variables.md) section. Make sure you set all the **Required** variables.
143+
{% endstep %}
141144
142-
<table><thead><tr><th width="218">Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>APP_KEY</code></td><td><p>Key used to encrypt and decrypt data.</p><p>You can generate a key at <a href="https://speedtest-tracker.dev">https://speedtest-tracker.dev</a>.</p></td><td><code>base64:ZoOYTjS+LBwFtud8SArwhiw8V4Qi9J+MPiT7z8XjfMo=</code><br>(DONT USE THIS EXAMPLE)</td></tr><tr><td><code>APP_TIMEZONE</code></td><td>Application timezone should be set if your database does not use UTC as its default timezone.</td><td><code>Europe/London</code></td></tr><tr><td><code>DISPLAY_TIMEZONE</code></td><td>Display timestamps in your local time.</td><td><code>Europe/London</code></td></tr></tbody></table>
145+
{% step %}
146+
### Speedtest Variables
143147
148+
Optionally you can set variables to have automatic speedtest on an schedule. Check out the [Environment Variables](environment-variables.md#speedtest) section on how to set the variables. As well see the [FAQ](../help/faqs.md#speedtest) for tips on the best schedule&#x20;
149+
{% endstep %}
144150
151+
{% step %}
152+
### Start the Container
145153
154+
You can now start the container comform the platform you are on.&#x20;
155+
{% endstep %}
146156
157+
{% step %}
158+
### First Login
147159
148-
Optionally you can set a schedule for automatic speedtest. Check out the tips for the best schedule [here](../help/faqs.md#cron-schedule-from-a-minute-or-hour).&#x20;
160+
During the start the container there is an defualt username and password create. Use the default log credentials to login to the application. You can change the default after logging in.&#x20;
161+
{% endstep %}
162+
{% endstepper %}
149163
150164
{% hint style="info" %}
151165
Complete overview of the Environment Variables for custom configuration can be found [here](environment-variables.md)

0 commit comments

Comments
 (0)