You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: getting-started/installation.md
+22-10Lines changed: 22 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,14 @@ description: >-
8
8
9
9
These steps will run you through setting up the application using Docker and Docker Compose.
10
10
11
-
### Install with Docker 
11
+
### Install with Docker
12
+
13
+
#### Docker Compose
12
14
13
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.
14
16
15
17
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`.
16
18
17
-
{% hint style="info" %}
18
-
Complete overview of the Environment Variables can be found [here](environment-variables.md)
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). 
149
+
150
+
{% hint style="info" %}
151
+
Complete overview of the Environment Variables for custom configuration can be found [here](environment-variables.md)
0 commit comments