Created the documentation index file

This commit is contained in:
Mathias
2022-08-05 22:33:57 +02:00
parent 56dc766ab0
commit 4f34cf9aaa

17
docs/index.md Normal file
View File

@@ -0,0 +1,17 @@
# MySpeed Dokumentation
In dieser Dokumentation wird dir erklärt, wie du MySpeed auf einem Server deiner Wahl installierst, einstellst und verwendest.
!!! note ""
Hast du noch einen Vorschlag oder einen Bug gefunden? Dann öffne doch ein [Issue](https://github.com/gnmyt/myspeed/issues) oder schreibe mir eine Nachricht auf [Discord (GNM#0001)](https://discord.com/users/386242172632170496)
## Was ist das überhaupt?
MySpeed ist eine deutschsprachige Software, welche dir hilft, dein Internet in den letzten 24 Stunden nachzuvollziehen. Das kann auch dann nützlich sein, wenn du wissen möchtest, wann dein Netzwerk möglicherweise Einbrüche hat oder wenn du überprüfen möchtest, ob dein Internet mit den gebuchten Werten aus deinem Vertrag übereinstimmt.
Es wird empfohlen, die Software Zuhause zu installieren. Sie lässt sich selbstverständlich aber auch auf einem Server in einem Rechenzentrum installieren, falls du das möchtest. ;)
## Wie funktioniert das?
MySpeed erstellt jede Stunde automatisiert Tests, welche du dir in einem Dashboard dann ansehen kannst. Ist ein Test älter als 24 Stunden, so wird er gelöscht, um das Dashboard übersichtlicher zu halten.
## Was brauche ich?
Zusammengefasst nur ein Gerät, welches in der Lage ist, **24/7** zu laufen und von **NodeJS** unterstützt wird. Dazu gehören unter anderem Windows, macOS oder Linux.
Auch wenn es möglich ist, das System auf einem normalen Rechner zu installieren, wird es empfohlen, es auf einem Gerät zu installieren, welches wenig Strom verbraucht. Perfekt dafür geeignet wäre beispielsweise ein sogenannter [Raspberry Pi](https://www.raspberrypi.com/) oder andere [Mini-PCs](https://www.amazon.de/s?k=mini+pc).