Skip to content

Commit 05017da

Browse files
authored
[Documentation] Updated docs for v1 (alexjustesen#1914)
1 parent 9b0fb13 commit 05017da

File tree

5 files changed

+16
-129
lines changed

5 files changed

+16
-129
lines changed

.github/screenshots/dashboard.jpeg

231 KB
Loading
-79.9 KB
Binary file not shown.

README.md

Lines changed: 13 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,23 @@
11
# 🐇 Speedtest Tracker
22

3-
Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtests using Ookla's Speedtest service.
3+
Speedtest Tracker is a self-hosted application that monitors the performance and uptime of your internet connection.
44

5-
[![Star History Chart](https://api.star-history.com/svg?repos=alexjustesen/speedtest-tracker&type=Date)](https://star-history.com/#alexjustesen/speedtest-tracker&Date)
6-
7-
### Why might I use this?
5+
![Dashboard](.github/screenshots/dashboard.jpeg)
86

9-
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.
7+
## Features
108

11-
### What about that other Speedtest Tracker?
12-
13-
As far as I can tell https://github.com/henrywhitaker3/Speedtest-Tracker was abandoned. This is meant to be an actively maintained replacement with an improved UI and feature set.
9+
- **Automated Tests**: Schedule regular speed tests to monitor your internet connection's performance over time.
10+
- **Detailed Metrics**: Capture download and upload speeds, ping, packet loss and more.
11+
- **Historical Data**: View historical data and trends to identify patterns and issues with your internet connection.
12+
- **Notifications**: Receive notifications when your internet performance drops below a certain threshold.
1413

1514
## Getting Started
1615

17-
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).
18-
19-
### Quick Start
20-
21-
#### Docker
22-
23-
```bash
24-
docker run -d --name speedtest-tracker --restart unless-stopped \
25-
-p 8080:80 \
26-
-e PUID=1000 \
27-
-e PGID=1000 \
28-
-e APP_KEY= \ # How to generate an app key: https://speedtest-tracker.dev/
29-
# -e SPEEDTEST_SCHEDULE= \ # optional: schedule a speedtest with an cronjob https://crontab.guru
30-
-e APP_URL=http://localhost \
31-
-e DB_CONNECTION=sqlite \
32-
-v ${PWD}:/config \
33-
lscr.io/linuxserver/speedtest-tracker:latest
34-
```
35-
36-
#### Docker Compose
37-
38-
```bash
39-
services:
40-
speedtest-tracker:
41-
container_name: speedtest-tracker
42-
ports:
43-
- 8080:80
44-
- 8443:443
45-
environment:
46-
- PUID=1000
47-
- PGID=1000
48-
- APP_KEY= # How to generate an app key: https://speedtest-tracker.dev/
49-
- APP_URL=http://localhost
50-
- DB_CONNECTION=sqlite
51-
# - SPEEDTEST_SCHEDULE= # optional: schedule a speedtest with an cronjob https://crontab.guru
52-
volumes:
53-
- /path/to/data:/config
54-
- /path/to-custom-ssl-keys:/config/keys
55-
image: lscr.io/linuxserver/speedtest-tracker:latest
56-
restart: unless-stopped
57-
```
58-
For more environment configuration to customize your installation see the docs: https://docs.speedtest-tracker.dev/getting-started/environment-variables
16+
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).
5917

18+
- [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.
19+
- [Configurations](https://docs.speedtest-tracker.dev/getting-started/environment-variables) are used to tailor Speedtest Tracker to your needs.
20+
- [Notifications](https://docs.speedtest-tracker.dev/settings/notifications) channels alert you when issues happen.
21+
- [Frequently Asked Questions](https://docs.speedtest-tracker.dev/help/faqs) are common questions that can help you resolve issues.
6022

61-
## Image version
62-
63-
A full list of released versions can be found here: https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker
64-
65-
### FAQs and Features
66-
67-
[FAQs](https://docs.speedtest-tracker.dev/faqs) and a full list of planned and completed [features](https://docs.speedtest-tracker.dev/getting-started/features) can be found in the [documentation](https://docs.speedtest-tracker.dev).
68-
69-
## API
70-
71-
A robust API is planned for a later release but as of `v0.11.8` a legacy endpoint `/api/speedtest/latest` which is used by home lab dashboards like [Homepage](https://github.com/benphelps/homepage) and [Organizr](https://github.com/causefx/Organizr/tree/v2-master).
72-
73-
## Screenshots
74-
75-
![Dashboard](.github/screenshots/dashboard_screenshot.jpg)
76-
**Dashboard**
23+
[![Star History Chart](https://api.star-history.com/svg?repos=alexjustesen/speedtest-tracker&type=Date)](https://star-history.com/#alexjustesen/speedtest-tracker&Date)

SECURITY.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22

33
## Reporting a Vulnerability
44

5-
Found a security vulnerability? **DON'T open an issue**, report it to [[email protected]](mailto:[email protected]) so I can address it promptly.
5+
Found a security vulnerability?
6+
7+
**DON'T open an issue**, report it to [[email protected]](mailto:[email protected]) so I can address it promptly.

🐇 Speedtest Tracker.postman_collection.json

Lines changed: 0 additions & 62 deletions
This file was deleted.

0 commit comments

Comments
 (0)