Skip to content

Commit 0669672

Browse files
alexjustesengitbook-bot
authored andcommitted
GITBOOK-52: change request with no subject merged in GitBook
1 parent ef29e19 commit 0669672

File tree

5 files changed

+28
-14
lines changed

5 files changed

+28
-14
lines changed

faqs.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,26 @@ By default Ookla's CLI only returns the "closest" 20 servers. If the server you'
5959

6060
</details>
6161

62+
### Time zones
63+
64+
<details>
65+
66+
<summary>How do I set the display and schedule time zone?</summary>
67+
68+
Your local time can be set in the UI under `Settings -> General -> Time zone`.
69+
70+
</details>
71+
72+
<details>
73+
74+
<summary>My display timestamps or scheduled tests aren't correct.</summary>
75+
76+
Speedtest Tracker assumes your application and database containers are set to `UTC`, the only location to update the time zone is in the UI.
77+
78+
If you're passing a `TZ` environment variable or have manually changed the time zone of either the application or database containers this can affect how timestamps and the schedules tests are displayed and run.
79+
80+
</details>
81+
6282
### Other
6383

6484
<details>
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_KEY</code></td><td>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.<br><br>Currently not used and generated at random on startup of the container.</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>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></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_KEY</code></td><td>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.<br><br>Currently not used and generated at random on startup of the container.</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>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>ALLOW_EMBEDS</code></td><td>Can be a comma separated list of URLs that the application will allow to be embedded in.<br><br>- Default: <code>null</code></td></tr></tbody></table>

getting-started/installation/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Docker Compose is the recommended platform.
1010

1111
#### Core
1212

13-
<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. To find your UID run <code>id username</code> on the host machine.<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. To find your GID run <code>id username</code> on the host machine.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>APP_KEY</code></td><td>Key used to encrypt and decrypt data. To create a key to persist follow the directions in the <a href="../../faqs.md#i-get-a-warning-on-container-start-up-that-the-app_key-is-missing">FAQ</a>.<br><br><em>Currently not used and generated at random on startup of the container</em>.</td></tr><tr><td><code>APP_DEBUG</code></td><td>Used to help narrow down issues in a running container, see <a href="../../faqs.md#im-getting-a-500-or-server-error-error">FAQ</a> for when to use it.<br><br>- Default: <code>false</code></td></tr><tr><td><code>DB_CONNECTION</code><br><br>(required)</td><td>Type of database to be used for storing data. Accepted values are <code>sqlite</code>, <code>mysql</code> and <code>pgsql</code>.</td></tr><tr><td><code>DB_HOST</code><br><br>(required)</td><td>FQDN or container name where the database is located.</td></tr><tr><td><code>DB_PORT</code></td><td>Port used to connect to the host where the database is located. Only needs to be defined if the database is running on a different port.<br><br>- Default: <code>3306</code> when using MySQL or MariaDB<br>- Default: <code>5432</code> when using Postgresql</td></tr><tr><td>DB_DATABASE<br><br>(required)</td><td>Name of the database.</td></tr><tr><td><code>DB_USERNAME</code><br><br>(required)</td><td>Database user used to connect to the database. Needs <code>read/write</code> access.</td></tr><tr><td><code>DB_PASSWORD</code><br><br>(required)</td><td>Password for the user specified to connect to the database.</td></tr><tr><td><code>FORCE_HTTPS</code></td><td>Enforces the user of <code>https</code> protocol when viewing the UI, port 443 must be mapped to the container for this to work.<br><br>- Default: <code>false</code></td></tr></tbody></table>
13+
<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. To find your UID run <code>id username</code> on the host machine.<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. To find your GID run <code>id username</code> on the host machine.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>APP_KEY</code></td><td>Key used to encrypt and decrypt data. To create a key to persist follow the directions in the <a href="../../faqs.md#i-get-a-warning-on-container-start-up-that-the-app_key-is-missing">FAQ</a>.<br><br><em>Currently not used and generated at random on startup of the container</em>.</td></tr><tr><td><code>APP_DEBUG</code></td><td>Used to help narrow down issues in a running container, see <a href="../../faqs.md#im-getting-a-500-or-server-error-error">FAQ</a> for when to use it.<br><br>- Default: <code>false</code></td></tr><tr><td><code>DB_CONNECTION</code><br><br>(required)</td><td>Type of database to be used for storing data. Accepted values are <code>sqlite</code>, <code>mysql</code> and <code>pgsql</code>.</td></tr><tr><td><code>DB_HOST</code><br><br>(required)</td><td>FQDN or container name where the database is located.</td></tr><tr><td><code>DB_PORT</code></td><td>Port used to connect to the host where the database is located. Only needs to be defined if the database is running on a different port.<br><br>- Default: <code>3306</code> when using MySQL or MariaDB<br>- Default: <code>5432</code> when using Postgresql</td></tr><tr><td><code>DB_DATABASE</code><br><br>(required)</td><td>Name of the database.</td></tr><tr><td><code>DB_USERNAME</code><br><br>(required)</td><td>Database user used to connect to the database. Needs <code>read/write</code> access.</td></tr><tr><td><code>DB_PASSWORD</code><br><br>(required)</td><td>Password for the user specified to connect to the database.</td></tr><tr><td><code>FORCE_HTTPS</code></td><td>Enforces the user of <code>https</code> protocol when viewing the UI, port 443 must be mapped to the container for this to work.<br><br>- Default: <code>false</code></td></tr></tbody></table>
1414

1515
#### Functional
1616

17-
<table><thead><tr><th width="225">Name</th><th>Description</th></tr></thead><tbody><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>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></tbody></table>
17+
<table><thead><tr><th width="225">Name</th><th>Description</th></tr></thead><tbody><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>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>ALLOW_EMBEDS</code></td><td>Can be a comma separated list of URLs that the application will allow to be embedded in.<br><br>- Default: <code>null</code></td></tr></tbody></table>
1818

1919
***
2020

getting-started/installation/installation-1.md

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

99
{% hint style="warning" %}
10-
These directions are out-of-date as Synology has changed the `Docker` application to `Container Manager.`
10+
The following directions are for the old `Docker` application, if you're using the container manager you can follow the [installation.md](installation.md "mention") instructions.
1111
{% endhint %}
1212

1313
### Install on a Synology NAS

getting-started/installation/installation.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,8 @@ services:
2929
- DB_DATABASE=speedtest_tracker
3030
- DB_USERNAME=speedy
3131
- DB_PASSWORD=password
32-
- TZ=America/Chicago
3332
volumes:
34-
- '/etc/localtime:/etc/localtime:ro'
35-
- '/path/to/directory:/config'
33+
- speedtest-app:/config
3634
- '/path/to/directory/web:/etc/ssl/web'
3735
image: 'ghcr.io/alexjustesen/speedtest-tracker:latest'
3836
restart: unless-stopped
@@ -49,6 +47,7 @@ services:
4947
volumes:
5048
- speedtest-db:/var/lib/mysql
5149
volumes:
50+
speedtest-app:
5251
speedtest-db:
5352
```
5453
{% endtab %}
@@ -71,10 +70,8 @@ services:
7170
- DB_DATABASE=speedtest_tracker
7271
- DB_USERNAME=speedy
7372
- DB_PASSWORD=password
74-
- TZ=America/Chicago
7573
volumes:
76-
- '/etc/localtime:/etc/localtime:ro'
77-
- '/path/to/directory:/config'
74+
- speedtest-app:/config
7875
- '/path/to/directory/web:/etc/ssl/web'
7976
image: 'ghcr.io/alexjustesen/speedtest-tracker:latest'
8077
restart: unless-stopped
@@ -90,6 +87,7 @@ services:
9087
volumes:
9188
- speedtest-db:/var/lib/postgresql/data
9289
volumes:
90+
speedtest-app
9391
speedtest-db:
9492
```
9593
{% endtab %}
@@ -111,14 +109,12 @@ docker run -d --name speedtest-tracker --restart unless-stopped \
111109
-p 8443:443 \
112110
-e PUID=1000 \
113111
-e PGID=1000 \
114-
-e TZ=America/Chicago \
115112
-e DB_CONNECTION=mysql \
116113
-e DB_HOST= \
117114
-e DB_PORT=3306 \
118115
-e DB_DATABASE=speedtest_tracker \
119116
-e DB_USERNAME= \
120117
-e DB_PASSWORD= \
121-
-v /etc/localtime:/etc/localtime:ro \
122118
-v /path/to/directory:/config \
123119
-v /path/to/directory/web:/etc/ssl/web \
124120
ghcr.io/alexjustesen/speedtest-tracker:latest
@@ -138,8 +134,6 @@ docker run -d --name speedtest-tracker --restart unless-stopped \
138134
-e DB_DATABASE=speedtest_tracker \
139135
-e DB_USERNAME= \
140136
-e DB_PASSWORD= \
141-
-e TZ=America/Chicago \
142-
-v /etc/localtime:/etc/localtime:ro \
143137
-v /path/to/directory:/config \
144138
-v /path/to/directory/web:/etc/ssl/web \
145139
ghcr.io/alexjustesen/speedtest-tracker:latest

0 commit comments

Comments
 (0)