Skip to content

Commit 066e634

Browse files
svenvg93gitbook-bot
svenvg93
authored and
gitbook-bot
committed
GITBOOK-18: No subject
1 parent 809c7b1 commit 066e634

File tree

7 files changed

+121
-11
lines changed

7 files changed

+121
-11
lines changed

‎SUMMARY.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@
66

77
## 🚀 Getting Started
88

9-
* [Installation](getting-started/installation.md)
9+
* [Installation](getting-started/installation/README.md)
10+
* [Using Docker or Docker Compose](getting-started/installation/installation.md)
11+
* [Using Kubernetes](getting-started/installation/using-kubernetes.md)
12+
* [Using QNAP](getting-started/installation/using-qnap.md)
13+
* [Using Synology](getting-started/installation/using-synology.md)
14+
* [Using Unraid](getting-started/installation/using-unraid.md)
1015
* [Environment Variables](getting-started/environment-variables.md)
1116
* [Database Drivers](getting-started/database-drivers.md)
1217

‎getting-started/installation/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Installation
2+

getting-started/installation.md renamed to getting-started/installation/installation.md

Lines changed: 101 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@ description: >-
44
is Docker.
55
---
66

7-
# Installation
7+
# Using Docker or Docker Compose
88

99
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+
{% hint style="info" %}
14+
The Docker Run commands can be found below the compose examples. These instructions assume you have an appropriate database instance that already exists.
15+
{% endhint %}
16+
17+
18+
1319
{% stepper %}
1420
{% step %}
1521
#### Docker Compose
@@ -43,7 +49,25 @@ services:
4349
volumes:
4450
- /path/to/data:/config
4551
- /path/to-custom-ssl-keys:/config/keys
52+
```
4653
54+
***
55+
56+
```
57+
docker run -d --name speedtest-tracker --restart unless-stopped \
58+
-p 8080:80 \
59+
-p 8443:443 \
60+
-e PUID=1000 \
61+
-e PGID=1000 \
62+
-e DB_CONNECTION=sqlite \
63+
-e APP_KEY= \
64+
-e DATETIME_FORMAT= \
65+
-e APP_TIMEZONE= \
66+
-e SPEEDTEST_SCHEDULE= \
67+
-e SPEEDTEST_SERVERS= \
68+
-v /path/to/data:/config \
69+
-v /path/to-custom-ssl-keys:/config/keys \
70+
lscr.io/linuxserver/speedtest-tracker:latest
4771
```
4872
{% endtab %}
4973

@@ -88,6 +112,32 @@ services:
88112
volumes:
89113
speedtest-db:
90114
</code></pre>
115+
116+
***
117+
118+
```
119+
docker run -d --name speedtest-tracker --restart unless-stopped \
120+
-p 8080:80 \
121+
-p 8443:443 \
122+
-e PUID=1000 \
123+
-e PGID=1000 \
124+
-e DB_CONNECTION=mariadb \
125+
-e DB_HOST= \
126+
-e DB_PORT=3306 \
127+
-e DB_DATABASE=speedtest_tracker \
128+
-e DB_USERNAME= \
129+
-e DB_PASSWORD= \
130+
-e APP_KEY= \
131+
-e DATETIME_FORMAT= \
132+
-e APP_TIMEZONE= \
133+
-e SPEEDTEST_SCHEDULE= \
134+
-e SPEEDTEST_SERVERS= \
135+
-v /path/to/data:/config \
136+
-v /path/to-custom-ssl-keys:/config/keys \
137+
lscr.io/linuxserver/speedtest-tracker:latest
138+
```
139+
140+
91141
{% endtab %}
92142

93143
{% tab title="MySQL" %}
@@ -133,7 +183,29 @@ volumes:
133183
speedtest-db:
134184
```
135185
186+
***
136187
188+
```
189+
docker run -d --name speedtest-tracker --restart unless-stopped \
190+
-p 8080:80 \
191+
-p 8443:443 \
192+
-e PUID=1000 \
193+
-e PGID=1000 \
194+
-e DB_CONNECTION=mysql \
195+
-e DB_HOST= \
196+
-e DB_PORT=3306 \
197+
-e DB_DATABASE=speedtest_tracker \
198+
-e DB_USERNAME= \
199+
-e DB_PASSWORD= \
200+
-e APP_KEY= \
201+
-e DATETIME_FORMAT= \
202+
-e APP_TIMEZONE= \
203+
-e SPEEDTEST_SCHEDULE= \
204+
-e SPEEDTEST_SERVERS= \
205+
-v /path/to/data:/config \
206+
-v /path/to-custom-ssl-keys:/config/keys \
207+
lscr.io/linuxserver/speedtest-tracker:latest
208+
```
137209
{% endtab %}
138210

139211
{% tab title="Postgres" %}
@@ -177,20 +249,44 @@ services:
177249
volumes:
178250
speedtest-db:
179251
```
252+
253+
***
254+
255+
```
256+
docker run -d --name speedtest-tracker --restart unless-stopped \
257+
-p 8080:80 \
258+
-p 8443:443 \
259+
-e PUID=1000 \
260+
-e PGID=1000 \
261+
-e DB_CONNECTION=pgsql \
262+
-e DB_HOST= \
263+
-e DB_PORT=3306 \
264+
-e DB_DATABASE=speedtest_tracker \
265+
-e DB_USERNAME= \
266+
-e DB_PASSWORD= \
267+
-e APP_KEY= \
268+
-e DATETIME_FORMAT= \
269+
-e APP_TIMEZONE= \
270+
-e SPEEDTEST_SCHEDULE= \
271+
-e SPEEDTEST_SERVERS= \
272+
-v /path/to/data:/config \
273+
-v /path/to-custom-ssl-keys:/config/keys \
274+
lscr.io/linuxserver/speedtest-tracker:latest
275+
```
180276
{% endtab %}
181277
{% endtabs %}
182278
{% endstep %}
183279

184280
{% step %}
185281
#### Environment Variables
186282

187-
In order for the application to run smoothly, some environment variables need to be set. Check out the [Environment Variables](environment-variables.md) section. Make sure you set all the **Required** variables.
283+
In order for the application to run smoothly, some environment variables need to be set. Check out the [Environment Variables](../environment-variables.md) section. Make sure you set all the **Required** variables.
188284
{% endstep %}
189285

190286
{% step %}
191287
#### Speedtest Variables
192288

193-
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;
289+
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;
194290
{% endstep %}
195291

196292
{% step %}
@@ -202,16 +298,11 @@ You can now start the container accordingly the platform you are on.&#x20;
202298
{% step %}
203299
#### First Login
204300

205-
During the start the container there is an default username and password created. Use the [default login](../security/authentication.md#default-user-account) credentials to login to the application. You can [change the default user](../security/authentication.md#change-user-account) after logging in.&#x20;
301+
During the start the container there is an default username and password created. Use the [default login](../../security/authentication.md#default-user-account) credentials to login to the application. You can [change the default user](../../security/authentication.md#change-user-account) after logging in.&#x20;
206302
{% endstep %}
207303
{% endstepper %}
208304

209305
{% hint style="info" %}
210-
Complete overview of the Environment Variables for custom configuration can be found [here](environment-variables.md)
306+
Complete overview of the Environment Variables for custom configuration can be found [here](../environment-variables.md)
211307
{% endhint %}
212308

213-
### Install with Kubernetes
214-
215-
Check out this amazing community kubernetes manifest to get you started.
216-
217-
{% embed url="https://github.com/maximemoreillon/kubernetes-manifests/tree/master/speedtest-tracker" %}

‎getting-started/installation/using-kubernetes.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Using Kubernetes
2+
3+
Check out this amazing community kubernetes manifest to get you started.
4+
5+
{% embed url="https://github.com/maximemoreillon/kubernetes-manifests/tree/master/speedtest-tracker" %}
6+

‎getting-started/installation/using-qnap.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Using QNAP
2+

‎getting-started/installation/using-synology.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Using Synology
2+

‎getting-started/installation/using-unraid.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Using Unraid
2+

0 commit comments

Comments
 (0)