Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# Speedtest Tracker
# 🐇 Speedtest Tracker

> [!IMPORTANT]
> `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.
Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtests using Ookla's Speedtest service.

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

## Introduction

Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtest checks against Ookla's Speedtest service.

### Why might I use this?

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.
Expand All @@ -28,9 +23,13 @@ docker run -d --name speedtest-tracker --restart unless-stopped \
-p 8080:80 \
-e PUID=1000 \
-e PGID=1000 \
-e APP_KEY= # How to generate an app key: https://docs.speedtest-tracker.dev/getting-started/installation
-e APP_URL=http://localhost
-e DB_CONNECTION=sqlite \
-v /path/to/data:/config \
-v ${PWD}:/config \
lscr.io/linuxserver/speedtest-tracker:latest

# For more environment configuration see the docs: https://docs.speedtest-tracker.dev/getting-started/environment-variables
```

### FAQs and Features
Expand Down