## 1. Project Overview & Quickstart (alexjustesen/speedtest-tracker)

# 🐇 Speedtest Tracker

Speedtest Tracker is a self-hosted application that monitors the performance and uptime of your internet connection.



## Features

- **Automated Tests**: Schedule regular speed tests to monitor your internet connection's performance over time.
- **Detailed Metrics**: Capture download and upload speeds, ping, packet loss and more.
- **Historical Data**: View historical data and trends to identify patterns and issues with your internet connection.
- **Notifications**: Receive notifications when your internet performance drops below a certain threshold.
- **Multi-Language Support**: Available in multiple languages with community translations via [Crowdin](https://crowdin.com/project/speedtest-tracker).

## Getting Started

Speedtest Tracker is containerized so you can run it anywhere you run your containers. The image is built by LinuxServer.io, build information can be found [here](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker).

- [Installation](https://docs.speedtest-tracker.dev/getting-started/installation) guide will get you up and running and includes steps for deploying the Docker image or to NAS platforms like Synology and Unraid.
- [Configurations](https://docs.speedtest-tracker.dev/getting-started/environment-variables) are used to tailor Speedtest Tracker to your needs.
- [Notifications](https://docs.speedtest-tracker.dev/settings/notifications) channels alert you when issues happen.
- [Frequently Asked Questions](https://docs.speedtest-tracker.dev/help/faqs) are common questions that can help you resolve issues.

## Translations

Speedtest Tracker supports multiple languages thanks to our community translators!

**Request a new language**: Visit our [Crowdin project](https://crowdin.com/project/speedtest-tracker) and request a new language directly in crowdin.

**Help translate**: Join our [Crowdin project](https://crowdin.com/project/speedtest-tracker) to contribute translations in your language. All translation levels are welcome!

## 2. Official Technical Reference & Guides (alexjustesen/speedtest-tracker-docs)

## File: README.md

---
  Speedtest Tracker is a self-hosted application that monitors the performance
  and uptime of your internet connection. Build using Laravel and Speedtest CLI
  from Ookla®, deployable with Docker.
---

# Introduction

{% hint style="info" %}
Docs are up-to-date through version: `v1.14.x`
{% endhint %}

<figure><figcaption></figcaption></figure>

#### Why might I want this?

The main use case for Speedtest Tracker is to build a history of your internet performance and ISP's uptime so you can be informed when you're not receiving your ISP's advertised rates.

_...also some of us just like a lot of data._

#### What about that other Speedtest Tracker?

As far as I can tell [https://github.com/henrywhitaker3/Speedtest-Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker) was abandoned. This version is meant to be an actively maintained replacement with an improved UI and [feature](features.md) set.

#### Do you have a demo?

No, but [DB Tech](https://www.youtube.com/watch?v=feArak6WCLw), [Awesome Opens Source](https://www.youtube.com/watch?v=iyRUj77cjKg) and [Techdox](https://www.youtube.com/watch?v=vZiaWyuqsaY) over on YouTube have awesome videos showing you how to get Speedtest Tracker up and running with and a quick demo.

---

## File: getting-started/installation/README.md

# Installation

Speedtest Tracker is containerized so you can run it anywhere you run your containers. The image is built by LinuxServer.io, build information can be found [here](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker).

{% hint style="danger" %}
Only the installation methods listed below are supported. Any other installation methods, such as bare metal setups or Proxmox LXCs, are **not supported** by this project.
{% endhint %}

Use the install guides listed below to install Speedtest Tracker:

### Docker

* [Docker Compose](using-docker-compose.md)
* [Docker Run](using-docker.md)
* [Kubernetes](using-kubernetes.md)

### NAS Devices

* [QNAP](using-qnap.md)
* [Synology](using-synology.md)
* [Unraid](using-unraid.md)

---

## File: other/proxies/README.md

---
  Installation guides for when using Reverse Proxies. These configurations are
  provided by the community.
---

# Proxies

```
```

---

## File: settings/notifications/README.md

# Notifications

{% hint style="warning" %}
Database, Mail and Webhook notifications are considered "core" channels. We're currently working on integrating Apprise and all other notification channels should be considered deprecated.
{% endhint %}

---

## File: settings/data-platforms/README.md

# Data Platforms

Speedtest Tracker supports reporting data to InfluxDB2, a time series database. Additional data platforms are planned and listed on the [Features](../../features.md) page.