Skip to content

Latest commit

 

History

History
142 lines (90 loc) · 4.38 KB

README.md

File metadata and controls

142 lines (90 loc) · 4.38 KB

Contributors Forks Stargazers Issues MIT License Release


🤔 What is MySpeed?

MySpeed is a speed test analysis software that records your internet speed for up to 30 days.

⭐ Features

  • 📊 MySpeed generates clear statistics on speed, ping, and more
  • ⏰ MySpeed automates speed tests and allows you to set the time between tests using Cron expressions
  • 🗄️ Add multiple servers directly to a MySpeed instance
  • 🩺 Configure health checks to notify you via email, Signal, WhatsApp, or Telegram in case of errors or downtime
  • 📆 Test results can be stored for up to 30 days
  • 🔥 Support for Prometheus and Grafana
  • 🗳️ Choose between Ookla, LibreSpeed and Cloudflare speed test servers
  • 💁 Learn more about MySpeed on our website

Dependencies

Install the system dependencies below to build this project by following the instructions in the provided links. You can also find detailed steps to setup your environment in the service packaging documentation.

Cloning

Clone the package repository locally.

git clone https://github.com/j34g/MySpeed-Start9.git
cd MySpeed-Start9

Building

To build the service as a universal package, run the following command:

make

Alternatively the package can be built for individual architectures by specifying the architecture as follows:

make x86

or

make arm

Installing (on StartOS)

Before installation, define host: https://server-name.local in your ~/.embassy/config.yaml config file then run the following commands to determine successful install:

Change server-name.local to your Start9 server address

start-cli auth login
#Enter your StartOS password
make install

Tip: You can also install the myspeed.s9pk by sideloading it under the StartOS > System > Sideload a Service section.

Verify Install

Go to your StartOS Services page, select MySpeed and start the service.

Done!

📸 Example Screenshots

Homepage (List View)

Homepage

Homepage (Statistics View)

Statistics

Server Selection

Server Selection

Dropdown Menu

Dropdown Menu

Page During a Speed Test

Page During a Speed Test

Convinced?

Great, let's get started! You can find the installation instructions for Linux (and Windows) at the top under Installation.

License

Distributed under the MIT license. See LICENSE for more information.