mirror of
https://github.com/alexjustesen/speedtest-tracker.git
synced 2026-06-23 07:20:09 +00:00
[Chore] README.md and template updates (#1139)
This commit is contained in:
@@ -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.
|
Before Width: | Height: | Size: 152 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 82 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 202 KiB |
@@ -1,5 +1,7 @@
|
||||
# Speedtest Tracker
|
||||
|
||||
[](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.
|
||||
@@ -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).
|
||||
|
||||
[](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
|
||||
|
||||
@@ -30,9 +42,3 @@ A robust API is planned for a later release but as of `v0.11.8` a legacy endpoin
|
||||
|
||||

|
||||
**Dashboard**
|
||||
|
||||

|
||||
**Results page**
|
||||
|
||||

|
||||
**General Settings page**
|
||||
|
||||
Reference in New Issue
Block a user