Merge pull request #303 from gnmyt/updates/i18n-docs

🌐 Dokumentation auf Englisch übersetzt
gnmyt · May 29, 2023 · 419f8ad · 419f8ad
2 parents 269ea70 + c8dde0a
commit 419f8ad
Show file tree

Hide file tree

Showing 34 changed files with 710 additions and 89 deletions.
diff --git a/.github/workflows/upload_docs.yml b/.github/workflows/upload_docs.yml
@@ -15,7 +15,7 @@ jobs:
           python-version: 3.9
 
       - name: Install dependencies
-        run: pip install mkdocs-material
+        run: pip install mkdocs-material mkdocs-static-i18n
 
       - name: Deploy documentation
         run: mkdocs gh-deploy --force
diff --git a/docs/assets/images/all_tests.png b/docs/assets/images/all_tests.png
diff --git a/docs/assets/images/de/integrations.png b/docs/assets/images/de/integrations.png
diff --git a/docs/assets/images/de/interface.png b/docs/assets/images/de/interface.png
diff --git a/docs/assets/images/de/latest.png b/docs/assets/images/de/latest.png
diff --git a/docs/assets/images/de/settings.png b/docs/assets/images/de/settings.png
diff --git a/docs/assets/images/de/tests.png b/docs/assets/images/de/tests.png
diff --git a/docs/assets/images/de/view.png b/docs/assets/images/de/view.png
diff --git a/docs/assets/images/en/integrations.png b/docs/assets/images/en/integrations.png
diff --git a/docs/assets/images/en/interface.png b/docs/assets/images/en/interface.png
diff --git a/docs/assets/images/en/latest.png b/docs/assets/images/en/latest.png
diff --git a/docs/assets/images/en/settings.png b/docs/assets/images/en/settings.png
diff --git a/docs/assets/images/en/tests.png b/docs/assets/images/en/tests.png
diff --git a/docs/assets/images/en/view.png b/docs/assets/images/en/view.png
diff --git a/docs/assets/images/myspeed_interface.png b/docs/assets/images/myspeed_interface.png
diff --git a/docs/assets/images/settings.png b/docs/assets/images/settings.png
diff --git a/docs/faq.md → docs/faq.de.md b/docs/faq.md → docs/faq.de.md
@@ -2,12 +2,12 @@
 Hier beantworten wir dir die Fragen, die möglicherweise auftreten könnten.
 
 ??? question "Wie installiere ich MySpeed?"
-    Je nach Betriebssystem ist diese Anleitung unterschiedlich. Hier findest du die Anleitung für [Windows](/setup/windows) und [Linux](/setup/linux).  
+    Je nach Betriebssystem ist diese Anleitung unterschiedlich. Hier findest du die Anleitung für [Windows](../setup/windows) und [Linux](../setup/linux).  
     Allerdings wird es stark empfohlen, MySpeed unter Linux zu installieren.
 
 ??? question "Was sind die Anforderungen?"
     Es kommt darauf an, was für eine Bandbreite du hast. Bei Linux wäre es zum Beispiel so:
-    Wenn du ein Maximum von 100 Mbits anliegen hast, dann reicht ein RaspberryPi 1 oder ein anderer alter Computer.
+    Wenn du ein Maximum von 100 Mbit/s anliegen hast, dann reicht ein RaspberryPi 1 oder ein anderer alter Computer.
     Wenn du eine Gbit-Leitung hast, wäre schon ein Raspberry Pi 4 oder ein PC mit 1Gbit LAN Support wichtig.
 
 ??? question "Kann ich trotz VPN MySpeed verwenden?"
@@ -19,10 +19,12 @@ Hier beantworten wir dir die Fragen, die möglicherweise auftreten könnten.
     MySpeed dient in dem Fall nur zu Informationszwecken und hat keinerlei rechtliche Garantien.
 
 ??? question "Was kann die Speedtests beeinflussen?"
-    Im Grunde das übermäßige Nutzen der verfügbaren Bandbreite, was an sich gut ist. So siehst du dann auch, wie viel noch zur Verfügung steht.
+    Es gibt viele Faktoren, die die Geschwindigkeitstests beeinflussen können. Wenn Sie zum Beispiel viele Hintergrunddienste haben
+    laufen, können diese die Ergebnisse beeinflussen. Am besten schalten Sie diese zu den jeweiligen Testzeiten ab, da sonst die
+    Ergebnisse verfälscht werden könnten.
 
 ??? question "Was passiert mit den alten Testergebnissen?"
-    Die alten Testergebnisse werden automatisch gelöscht, sobald sie älter als 24 Stunden sind.
+    Die alten Testergebnisse werden automatisch gelöscht, sobald sie älter als 30 Tage sind.
 
 ??? question "Muss es dauerhaft laufen?"
     Wir empfehlen es, um bessere Ergebnisse zu erhalten. Wenn es dich beim Filme streamen etc. stört, 
@@ -46,7 +48,7 @@ Hier beantworten wir dir die Fragen, die möglicherweise auftreten könnten.
         Es ist sehr wahrscheinlich, dass Hintergrunddienste deine Geschwindigkeiten beeinflussen. Schalte diese am besten bei den jeweiligen Testzeiten ab, da sonst dein Ergebnis manipuliert werden könnte.
 
 ??? question "Wie setze ich mein Passwort zurück?"
-    Du hast dein MySpeed-Passwort vergessen? Das passiert, kein Problem. Zum zurücksetzen navigiere in den Installationsort (`cd /opt/myspeed`) und führe den folgenden Befehl aus:
+    Du hast dein MySpeed-Passwort vergessen? Das passiert, kein Problem. Zum Zurücksetzen navigiere in den Installationsort (`cd /opt/myspeed`) und führe den folgenden Befehl aus:
     ```sh
     node -e "const {Sequelize} = require('sequelize');const db = new Sequelize({dialect: 'sqlite', storage: 'data/storage.db'});db.query('UPDATE config SET value=? WHERE key=?', {replacements: ['none', 'password']})"
     ```    

diff --git a/docs/faq.en.md b/docs/faq.en.md
@@ -0,0 +1,61 @@
+# Questions & Answers
+
+Here we answer the questions you might have.
+
+??? question "How do I install MySpeed?"
+    Depending on your operating system these instructions are different. Here you can find the instructions
+    for [Windows](../setup/windows) and [Linux](../setup/linux).  
+    However, it is strongly recommended to install MySpeed on Linux.
+
+??? question "What are the requirements?"
+    It depends on what kind of bandwidth you have. For Linux, for example, it would be like this:
+    If you have a maximum of 100 Mbps on, then a RaspberryPi 1 or any other old computer will do the trick.
+    If you have a Gbit line, a Raspberry Pi 4 or a PC with 1Gbit LAN support would be important.
+
+??? question "Can I use MySpeed despite VPN?"
+    As long as you don't use your VPN service on the same system as the one where MySpeed is running, it's not a problem.
+    Otherwise, your VPN might distort the results or not reflect them realistically.
+
+??? question "Does this information serve as official proof for my ISP?"
+    No. The speed tests have to be done by the speed test service of your provider.
+    In this case MySpeed serves only for information purposes and has no legal guarantees.
+
+??? question "What can influence the speed tests?"
+    There are many factors that can influence the speed tests. For example, if you have a lot of background services
+    running, they can affect the results. It is best to turn them off at the respective test times, otherwise your
+    results could be manipulated.
+
+??? question "What happens to the old test results?"
+    The old test results are automatically deleted as soon as they are older than 30 days.
+
+??? question "Does it have to run permanently?"
+    We recommend it to get better results. If it bothers you while streaming movies etc.,
+    you can also pause it via the web interface for a certain time or manually.
+    For 24/7 operation, we recommend a system that doesn't need a lot of watts. In this case we recommend a Raspberry Pi.
+    If you already have a server running all the time, you can also run it there in parallel.
+
+??? question "How can I distinguish between manual and automatic speed tests?"
+    Click on the clock symbol of the respective test. There you will find all information about the speed test.
+
+??? question "Does the "Recommendations" function show my correct bandwidth?"
+    No, this is a calculated value from your last 10 speed tests. The available bandwidth will be found in your connection
+    contract.
+
+??? question "Can the developer see my test results?"
+    No, the test results are only visible locally on the server.
+
+??? question "Why should I configure frequencies?"
+    It depends very much on your internet. For example, if you have a very bad internet, you should rather decrease the
+    frequency. If your internet is quite fast, you can increase it. On this basis, more or less tests will be made,
+    depending on the situation.
+
+    ???+ warning "Attention"
+        It is very likely that background services are affecting your speeds. It is best to turn them off at the respective test times, otherwise your results could be manipulated.
+
+??? question "How do I reset my password?"
+    You forgot your MySpeed password? It happens, no problem. To reset it, navigate to the installation
+    location (`cd /opt/myspeed`) and execute the following command:
+    ```sh
+    node -e "const {Sequelize} = require('sequelize');const db = new Sequelize({dialect: 'sqlite', storage: 'data/storage.db'});db.query('UPDATE config SET value=? WHERE key=?', {replacements: ['none', 'password']})"
+    ```    
+    Then you can go to the page again and set your password manually :)
diff --git a/docs/guides/reverse-proxy.md → docs/guides/reverse-proxy.de.md b/docs/guides/reverse-proxy.md → docs/guides/reverse-proxy.de.md
@@ -1,3 +1,5 @@
+# Konfiguration eines Reverse Proxies
+
 In diesem Guide wird erklärt, wie du mithilfe von `apache` oder `nginx` einen Reverse Proxy mit MySpeed einrichtest.
 
 !!! tip "Warum einen Reverse Proxy verwenden?"

diff --git a/docs/guides/reverse-proxy.en.md b/docs/guides/reverse-proxy.en.md
@@ -0,0 +1,103 @@
+This guide explains how to set up a reverse proxy with MySpeed using `apache` or `nginx`.
+
+!!! tip "Why use a reverse proxy?"
+    In this case we use a reverse proxy as an intermediate layer between you and MySpeed.
+    This has the advantage that you don't have to call MySpeed via a port, but via a normal domain.
+
+## Installation
+If you already have a reverse proxy installed, you can skip this step. Which of the two
+reverse proxies you want to use is up to you. However, we recommend `nginx` for this guide.
+
+=== "nginx"
+    ```sh
+    sudo apt-get install nginx -y
+    ```
+
+=== "apache"
+    ```sh
+    sudo apt-get install apache2 -y
+    ```
+
+## Configuring MySpeed
+
+This section explains how to connect MySpeed to your reverse proxy. Again, select here
+which reverse proxy you used.
+
+=== "nginx"
+    Now create a file named `myspeed.conf` under `/etc/nginx/sites-available`. Here we use `nano`
+    ```sh
+    sudo nano /etc/nginx/sites-available/myspeed.conf
+    ```
+    Now add the following content to the file:
+    ```nginx
+    server {
+        listen 80;
+        listen [::]:80;
+
+        server_name your-domain.com;
+
+        location / {
+            proxy_pass http://localhost:5216;
+        }
+    }
+    ```
+    Now you just have to activate the file and restart the reverse proxy.
+    ```sh
+    sudo ln -s /etc/nginx/sites-available/myspeed.conf /etc/nginx/sites-enabled/myspeed.conf
+    sudo systemctl restart nginx
+    ```
+
+=== "apache"
+    Now create a file named `myspeed.conf` under `/etc/apache2/sites-available`. Here we use `nano`
+    ```sh
+    sudo nano /etc/apache2/sites-available/myspeed.conf
+    ```
+    Now add the following content to the file:
+    ```apache
+    <VirtualHost *:80>
+        ServerName your-domain.com
+
+        ProxyPreserveHost On
+        ProxyPass / http://localhost:5216/
+        ProxyPassReverse / http://localhost:5216/
+    </VirtualHost>
+    ```
+    Now enable the `mod_proxy` and `mod_proxy_http` modules.
+    ```sh
+    sudo a2enmod proxy
+    sudo a2enmod proxy_http
+    ```
+    Now you just have to activate the file and restart the reverse proxy.
+    ```sh
+    sudo a2ensite myspeed.conf
+    sudo systemctl restart apache2
+    ```
+
+## Configuring an SSL certificate with Let's Encrypt
+
+This section explains how to set up an SSL certificate from Let's Encrypt for MySpeed.
+
+!!! tip "Are you using Cloudflare?"
+    If you use Cloudflare and don't want to set up an SSL certificate from Let's Encrypt, you can just use the
+    simply activate the Cloudflare proxy function. This is sufficient in most cases. If you
+    decide to use the Cloudflare proxy, you can skip this section.
+
+=== "nginx"
+    First you need to install certbot. For this we use `apt`.
+    ```sh
+    sudo apt-get install certbot python3-certbot-nginx -y
+    ```
+    Now you need to run Certbot and specify the domain you want to set up the certificate for.
+    ```sh
+    sudo certbot --nginx -d your-domain.com
+    ```
+
+=== "apache"
+    First you need to install certbot. For this we use `apt`.
+    ```sh
+    sudo apt-get install certbot python3-certbot-apache -y
+    ```
+    Now you need to run Certbot and specify the domain you want to set up the certificate for.
+    ```sh
+    sudo certbot --apache -d your-domain.com
+    ```
diff --git a/docs/index.de.md b/docs/index.de.md
@@ -0,0 +1,39 @@
+# 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 Speedtest-Analyse-Software, welche die Geschwindigkeit deines Internets bis zu 30 Tage lang speichert.
+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 30 Tage, 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).
+
+## :heart: Und ein großes Danke an ...
+
+- [Sierra Devoplers](https://sierra-dev.de/myspeed) für die dort erstellte Seite
+- [Ookla](https://www.ookla.com/) für die Testdaten und das großartige Testnetzwerk
+- [Alle Übersetzer](https://crowdin.com/project/myspeed) für das Anbieten in verschiedenen Sprachen
+- [Alle Mitwirkende](https://github.com/gnmyt/myspeed/graphs/contributors) für ihre Hilfe und die Arbeit in das Projekt
diff --git a/docs/index.en.md b/docs/index.en.md
@@ -0,0 +1,37 @@
+# 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#0001)](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
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/instructions/main.md → docs/instructions/main.de.md b/docs/instructions/main.md → docs/instructions/main.de.md
@@ -5,7 +5,7 @@ jedoch zu vermeiden, wird alles hier noch einmal erklärt.
 
 ## Die Oberfläche
 
-![MySpeed Oberfläche](/assets/images/myspeed_interface.png){: align="left" }
+![MySpeed Oberfläche](/assets/images/de/interface.png){: align="left" }
 
 Die Oberfläche von MySpeed ist in **3** Teile unterteilt.
 
@@ -14,24 +14,22 @@ eines Speedtests. Auf die Einstellungen wird [hier](../settings) genauer eingega
 
 Im **zweiten** Teil wird immer der aktuellste Speedtest angezeigt.
 
-Der **dritte** Teil zeigt alle Speedtests der letzten 24 Stunden an.
+Der **dritte** Teil zeigt alle erstellten Speedtests an.
 
 <br clear="both" />
 
 ## Letzter Test
-
-![Letzter Test](/assets/images/latest_test.png){align="left"}
+![Letzter Test](/assets/images/de/latest.png){align="left"}
 
 Dieses Teil zeigt immer den aktuellsten, also zuletzt erstellten Speedtest an. Klickt man auf ein Icon, öffnet sich
-das jeweilige Hilfe-Menü mit mehr Infos
+das jeweilige Hilfe-Menü mit mehr Informationen
 
 <br clear="both" />
 
 ## Übersicht aller Tests
 
-![Letzter Test](/assets/images/all_tests.png){align="left"}
+![Letzter Test](/assets/images/de/tests.png){align="left"}
 
-Hier lassen sich alle Tests anzeigen, die in den letzten 24 Stunden erstellt wurden. Auch hier kann man wieder auf das
-Ping, Down und Upload-Icon klicken, um ein Hilfe-Menü zu öffnen. Es lässt sich allerdings jetzt auch auf die Uhr links
-klicken, um einen Dialog mit weiteren Informationen zu öffnen. Dieser Dialog zeigt nun weitere Infos über den Test und
+Hier lassen sich alle Tests anzeigen, die erstellt wurden. Es lässt sich jetzt auch auf die Uhr links klicken, um 
+einen Dialog mit weiteren Informationen zu öffnen. Dieser Dialog zeigt nun weitere Informationen über den Test und 
 bietet sogar die Möglichkeit, ihn direkt zu löschen (falls nötig).