Skip to content
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.

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

Update README.md #1759

Merged
merged 2 commits into from
Oct 16, 2024
Merged

Update README.md #1759

merged 2 commits into from
Oct 16, 2024

Conversation

Kristoffeh
Copy link
Contributor

Add: schedule variable, as it is a feature most people are gonna want to customize

📃 Description

Most people are going to want to customize how often a speedtest is triggered. For several days I considered forking this and implementing it myself, until i found out it was already possible. The primary focus of this change is to easily show newcomers that it is indeed possible.

🪵 Changelog

✏️ Changed

  • Added SPEEDTEST_SCHEDULE to README.MD (defaults to 1 hour).

Add: schedule variable, as it is a feature most people are gonna want to customize
@svenvg93
Copy link
Contributor

Just my 2 cents;
Not sure if using the hour mark as a good idea. There have been multiple issues with reports that tests on the hour mark like 9:00, 10:00 etc give less results then a few minutes later due to congestion on network or Speedtest Server. Just to not cause more of these reports ourself ;)

@Kristoffeh
Copy link
Contributor Author

That is a good point. I suppose it doesn't really matter what it is set to originally, personally i trigger a speedtest every 15 minutes.

@svenvg93
Copy link
Contributor

For most it will be fine, but it might be weird if we suggest this schedule and then later advice not to do that 😅

@Kristoffeh
Copy link
Contributor Author

Yeah honestly. I just wanted to have this added to the readme so that new users are aware that this is customizable. I don't know how many days/weeks i spent troubleshooting this, at some point i considered triggering the speedtest myself and just appending the data to database, but thankfully i found that environment variable hehe.

Just my 2 cents; Not sure if using the hour mark as a good idea. There have been multiple issues with reports that tests on the hour mark like 9:00, 10:00 etc give less results then a few minutes later due to congestion on network or Speedtest Server. Just to not cause more of these reports ourself ;)

How about we can default something like SPEEDTEST_SCHEDULE=5,15,25,35,45,55 * * * *
While this version can be slightly harder to understand to some, this way we can avoid the full hour mark. Sure would've been nice to avoid those extra reports.

@svenvg93
Copy link
Contributor

I do agree that adding it is a good idea.
Maybe we should do the same as for the app key like

SPEEDTEST_SCHEDULE= # optional: schedule a speedtest go to https://crontab.guru to make the schedule.

@alexjustesen
Copy link
Owner

@Kristoffeh I'm happy to add the option in but can you comment the line out so it's "disabled" by default with no schedule suggestion?

- SPEEDTEST_SCHEDULE: Environment variable disabled by default
- SPEEDTEST_SCHEDULE: Removed cron job suggestion
@Kristoffeh
Copy link
Contributor Author

Awesome, thanks guys. I'm honestly surprised by the response times here. Its a great project you guys got going on, keep it up <3

@alexjustesen alexjustesen added the 📖 documentation Improvements or additions to documentation label Oct 16, 2024
@alexjustesen alexjustesen merged commit ae295dd into alexjustesen:main Oct 16, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants