Skip to content

Commit b87bdb1

Browse files
svenvg93gitbook-bot
authored andcommitted
GITBOOK-3: No subject
1 parent 5c76d53 commit b87bdb1

File tree

2 files changed

+24
-12
lines changed

2 files changed

+24
-12
lines changed

SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
## 🚀 Getting Started
88

9-
* [Database Drivers](getting-started/database-drivers.md)
10-
* [Environment Variables](getting-started/environment-variables.md)
119
* [Installation](getting-started/installation.md)
10+
* [Environment Variables](getting-started/environment-variables.md)
11+
* [Database Drivers](getting-started/database-drivers.md)
1212

1313
## 🆘 Help
1414

getting-started/installation.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,14 @@ description: >-
88

99
These steps will run you through setting up the application using Docker and Docker Compose.
1010

11-
### Install with Docker 
11+
### Install with Docker
12+
13+
#### Docker Compose
1214

1315
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.
1416

1517
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`.
1618

17-
{% hint style="info" %}
18-
Complete overview of the Environment Variables can be found [here](environment-variables.md)
19-
{% endhint %}
20-
2119
{% tabs %}
2220
{% tab title="SQLite" %}
2321
```yaml
@@ -49,6 +47,8 @@ services:
4947
```yaml
5048
services:
5149
speedtest-tracker:
50+
image: lscr.io/linuxserver/speedtest-tracker:latest
51+
restart: unless-stopped
5252
container_name: speedtest-tracker
5353
ports:
5454
- 8080:80
@@ -72,8 +72,6 @@ services:
7272
volumes:
7373
- /path/to/data:/config
7474
- /path/to-custom-ssl-keys:/config/keys
75-
image: lscr.io/linuxserver/speedtest-tracker:latest
76-
restart: unless-stopped
7775
depends_on:
7876
- db
7977
db:
@@ -95,6 +93,8 @@ volumes:
9593
```yaml
9694
services:
9795
speedtest-tracker:
96+
image: lscr.io/linuxserver/speedtest-tracker:latest
97+
restart: unless-stopped
9898
container_name: speedtest-tracker
9999
ports:
100100
- 8080:80
@@ -118,8 +118,6 @@ services:
118118
volumes:
119119
- /path/to/data:/config
120120
- /path/to-custom-ssl-keys:/config/keys
121-
image: lscr.io/linuxserver/speedtest-tracker:latest
122-
restart: unless-stopped
123121
depends_on:
124122
- db
125123
db:
@@ -137,7 +135,21 @@ volumes:
137135
{% endtab %}
138136
{% endtabs %}
139137
140-
The following environment variables need to be set: `APP_TIMEZONE`, `DATETIME_FORMAT`, and `APP_KEY`. Instructions on how to set them can be found [here](environment-variables.md).
138+
#### Setting Environment Variables
139+
140+
In order for the application to run smoothly, some environment variables need to be test.  
141+
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>
143+
144+
145+
146+
147+
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;
149+
150+
{% hint style="info" %}
151+
Complete overview of the Environment Variables for custom configuration can be found [here](environment-variables.md)
152+
{% endhint %}
141153
142154
### Install with Kubernetes
143155

0 commit comments

Comments
 (0)