Skip to content
Merged
Show file tree
Hide file tree
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
14 changes: 7 additions & 7 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# Description
## 📃 Description

A short description of the pull request changes should go here and the sections below should list in detail all changes. You can remove the sections you don't need.

## Changelog
## 🪵 Changelog

### Added
### Added

- one
- two

### Changed
### ✏️ Changed

- one
- two

### Fixed
### 🔧 Fixed

- one
- two

### Removed
### 🗑️ Removed

- one
- two

## Screenshots
## 📷 Screenshots

If this PR has any UI/UX changes it's strongly suggested you add screenshots here.
Binary file not shown.
Binary file removed .github/screenshots/login_screenshot.jpg
Binary file not shown.
Binary file removed .github/screenshots/results_screenshot.jpg
Binary file not shown.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Speedtest Tracker

[![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.
Expand All @@ -14,9 +16,19 @@ As far as I can tell https://github.com/henrywhitaker3/Speedtest-Tracker was aba

## Getting Started

Speedtest Tracker is containerized so you can run it anywhere you run your Docker containers. The [install](https://docs.speedtest-tracker.dev/getting-started/installation) documentation will get you up and running with using Docker or Docker Composer along with choosing a database (MySQL/MariaDB or Postgresql).
Speedtest Tracker is containerized so you can run it anywhere you run your Docker containers. The [install](https://docs.speedtest-tracker.dev/getting-started/installation) documentation will get you up and running with using Docker or Docker Composer along with choosing a database (SQLite, MySQL/MariaDB or Postgresql).

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

```dockerfile
docker run -d --name speedtest-tracker --restart unless-stopped \
-p 8080:80 \
-e PUID=1000 \
-e PGID=1000 \
-e DB_CONNECTION=sqlite \
-v /path/to/data:/config \
lscr.io/linuxserver/speedtest-tracker:latest
```

### FAQs and Features

Expand All @@ -30,9 +42,3 @@ A robust API is planned for a later release but as of `v0.11.8` a legacy endpoin

![Dashboard](.github/screenshots/dashboard_screenshot.jpg)
**Dashboard**

![Results page](.github/screenshots/results_screenshot.jpg)
**Results page**

![General Settings page](.github/screenshots/general_settings_screenshot.jpg)
**General Settings page**