myspeed/docs/index.en.md

# MySpeed Documentation

This documentation explains how to install, configure and use MySpeed on a server of your choice.

!!! note ""
    Did you find another suggestion or bug? Then open an [Issue](https://github.com/gnmyt/myspeed/issues) or write me a 
    message on [Discord (@GNM)](https://discord.com/users/386242172632170496)

## What is it?

MySpeed is a speed test analysis software that stores the speed of your internet for up to 30 days. This can also be
useful if you want to know when your network might have drops or if you want to check if your internet matches the
booked values from your contract.

It is recommended to install the software at home. Of course, it can also be installed on a server in a data center, if
you wish ;)

## How does it work?

MySpeed automatically creates tests every hour, which you can view in a dashboard. If a test is older than 30 days, it
will be deleted to keep the dashboard clearer.

## What do I need?

In summary, just a device that is capable of running **24/7** and is supported by **NodeJS**. This includes Windows,
macOS or Linux, among others.

Even though it is possible to install the system on a normal computer, it is recommended to install it on a device that
consumes little power. Perfect for this would be for example a so-called [Raspberry Pi](https://www.raspberrypi.com/) or
other [Mini-PCs](https://www.amazon.de/s?k=mini+pc).

## :heart: And a big thanks to ...

- [Sierra Devoplers](https://sierra-dev.de/myspeed) for the page created there
- [Ookla](https://www.ookla.com/) for the test data and the great test network
- [All translators](https://crowdin.com/project/myspeed) for providing it in different languages
- [All contributors](https://github.com/gnmyt/myspeed/graphs/contributors) for their help and work into the project