Skip to content

Commit 74ef970

Browse files
authored
[Docs] Updated readme for 0.20.0 release (alexjustesen#1461)
1 parent ec478c2 commit 74ef970

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
1-
# Speedtest Tracker
1+
# 🐇 Speedtest Tracker
22

3-
> [!IMPORTANT]
4-
> `v0.16.0` includes a breaking change that requires user action for existing installs. Read the [release](https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.16.0) notes regarding the data migration.
3+
Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtests using Ookla's Speedtest service.
54

65
[![Star History Chart](https://api.star-history.com/svg?repos=alexjustesen/speedtest-tracker&type=Date)](https://star-history.com/#alexjustesen/speedtest-tracker&Date)
76

8-
## Introduction
9-
10-
Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtest checks against Ookla's Speedtest service.
11-
127
### Why might I use this?
138

149
The main use case for Speedtest Tracker is to build a history of your internet's performance so that you can be informed when you're not receiving your ISP's advertised rates.
@@ -28,9 +23,13 @@ docker run -d --name speedtest-tracker --restart unless-stopped \
2823
-p 8080:80 \
2924
-e PUID=1000 \
3025
-e PGID=1000 \
26+
-e APP_KEY= # How to generate an app key: https://docs.speedtest-tracker.dev/getting-started/installation
27+
-e APP_URL=http://localhost
3128
-e DB_CONNECTION=sqlite \
32-
-v /path/to/data:/config \
29+
-v ${PWD}:/config \
3330
lscr.io/linuxserver/speedtest-tracker:latest
31+
32+
# For more environment configuration see the docs: https://docs.speedtest-tracker.dev/getting-started/environment-variables
3433
```
3534

3635
### FAQs and Features

0 commit comments

Comments
 (0)