Skip to content

Update README.md #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cron410 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ I hope this project will make it easier for users to monitor their Starlink conn

**What does this do?**
1. Collects information from the Starlink dish every 3 seconds such as: signal strength, alarms, obstructions and latency
2. Runs internet speed tests every 60 minutes (upload, download, ping)
2. Runs internet speed tests every 60 minutes (upload, download, ping)
3. Measures latency to multiple destinations globally every 3 seconds
4. Stores all the metrics in a local database (Prometheus time series database)
5. You can then view the metrics on pre-built dashboards or create your own dashboards in Grafana.
Expand All @@ -76,7 +76,7 @@ I hope this project will make it easier for users to monitor their Starlink conn
<img src="https://github.com/danopstech/starlink/raw/main/.docs/assets/overview.png" width="95%"/>
</p>

⚠️ IMPORTANT: When running; this will carry out speedtests every 60 minutes, which will download and upload a fair amount of data over time. Please bare this in mind if your internet connection fails over to tethered/mobile or a data chargeable supplier when Starlink is not available.
⚠️ IMPORTANT: When running; this will carry out speedtests every 60 minutes, which will download and upload a fair amount of data over time. Please bare this in mind if your internet connection fails over to tethered/mobile or a data chargeable supplier when Starlink is not available. The interval can be changed in `config/prometheus/prometheus.yml`

## 🏎️ Quick Start

Expand Down