Migrate setup/linux.md page

This commit is contained in:
Mathias Wagner
2024-07-12 21:55:04 +02:00
parent e3d9bbb82a
commit 8e47c057e8
3 changed files with 235 additions and 200 deletions

178
docs/de/setup/linux.md Normal file
View File

@@ -0,0 +1,178 @@
# Einrichtung unter Linux
Hier wird die Einrichtung von MySpeed unter Linux beschrieben. MySpeed kann auf verschiedene Arten installiert werden.
## Installation mit Docker
::: tip Hilfe
Du weißt nicht, wie man Docker installiert? Schau dir [diese Anleitung](https://docs.docker.com/engine/install/#server) an.
:::
::: code-group
```sh [Stabile Version]
docker run -d -p 5216:5216 -v myspeed:/myspeed/data --restart=unless-stopped --name MySpeed germannewsmaker/myspeed
```
```sh [Entwicklerversion]
docker run -d -p 5216:5216 -v myspeed:/myspeed/data --restart=unless-stopped --name MySpeed germannewsmaker/myspeed:development
```
:::
## Automatische Installation
::: code-group
```sh [Stabile Version]
bash <(curl -sSL https://install.myspeed.dev)
```
```sh [Entwicklerversion]
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/install.sh | bash -s -- --beta
```
:::
## Automatischer Deinstallationsprozess
Möchtest du MySpeed nicht mehr verwenden? Du kannst es leicht entfernen. Entscheide hier, ob du deine Daten behalten oder löschen möchtest.
::: warning Führe diese Befehle vorsichtig aus
Das Ausführen der Befehle führt zur Löschung / Deinstallation von MySpeed. Bitte sei dir dessen bewusst.
:::
::: code-group
```sh [Daten behalten]
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/uninstall.sh | bash -s -- --keep-data
```
```sh [Daten löschen]
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/uninstall.sh | bash
```
:::
## Manuelle Installation
```sh
sudo apt-get install wget curl unzip -y #(1)
# Dies ist nur erforderlich, wenn NodeJS noch nicht installiert ist
curl -sSL https://deb.nodesource.com/setup_18.x | bash
sudo apt-get install nodejs -y #(2)
mkdir /opt/myspeed && cd /opt/myspeed #(3)
wget $(curl -s https://api.github.com/repos/gnmyt/myspeed/releases/latest | grep browser_download_url | cut -d '"' -f 4) #(4)
unzip MySpeed-*.zip && rm MySpeed-*.zip #(5)
npm install #(6)
NODE_ENV=production node server #(7)
```
1. Hier werden alle notwendigen Pakete für die Installation des Projekts installiert.
2. Dieser Schritt installiert die neueste Version von NodeJS.
3. Erstelle nun den Ordner, in dem du MySpeed installieren möchtest. In diesem Fall ist es der Ordner `/opt/myspeed`.
4. Installiere nun die neueste Version von MySpeed.
5. Entpacke die gerade heruntergeladene Datei (danach kannst du sie löschen).
6. Installiere nun alle Abhängigkeiten.
7. Starte nun MySpeed. MySpeed ist jetzt auf Port 5216 verfügbar.
Wenn du planst, MySpeed im Hintergrund laufen zu lassen, siehe die Anleitung unten.
## Installation von MySpeed aus dem Quellcode
::: warning Achtung
Dieser Prozess installiert die neuste Entwicklungsversion von MySpeed. Fehler können auftreten.
:::
```sh
sudo apt-get install git curl -y #(1)
# Dies ist nur erforderlich, wenn NodeJS noch nicht installiert ist
curl -sSL https://deb.nodesource.com/setup_18.x | bash
sudo apt-get install nodejs -y #(2)
mkdir /opt/myspeed && cd /opt/myspeed #(3)
git clone https://github.com/gnmyt/myspeed.git . #(4)
npm install #(5)
cd client && npm install && npm run build && cd .. && mv client/build . #(6)
NODE_ENV=production node server #(7)
```
1. Hier installierst du alle notwendigen Pakete, um das Projekt zu installieren.
2. Dieser Schritt installiert die neuste Version von NodeJS.
3. Erstelle nun den Ordner, in welchen du MySpeed installieren möchtest. In diesem Fall ist das der Ordner `/opt/myspeed`.
4. Klone nun das MySpeed Repository, um Zugriff auf den Code zu erhalten.
5. Installiere nun alle Abhängigkeiten des Servers.
6. Jetzt kompilierst du die Oberfläche von MySpeed und verschiebst sie in den Ordner wo MySpeed sie lesen kann.
7. Jetzt wird MySpeed gestartet. MySpeed ist nun unter dem Port 5216 erreichbar.
Wenn du planst, MySpeed im Hintergrund laufen zu lassen, dann schau dir den Guide dafür unten an.
## MySpeed 24/7 installieren
::: warning Wichtig
Hast du das Installations-Script verwendet? Dann musst du diesen Schritt überhaupt nicht ausführen.
:::
Die Installation als Systemdienst ist nicht schwer. In diesem Fall verwenden wir `systemd`, da es in den meisten Linux-Distributionen direkt integriert ist.
1. Erstelle eine Datei namens `myspeed.service` unter `/etc/systemd/system`. Hier verwenden wir `nano`
```sh
nano /etc/systemd/system/myspeed.service
```
2. Füge nun den Inhalt der Datei ein.
```ini
[Unit]
Description=MySpeed
After=network.target
[Service]
Type=simple
ExecStart=/usr/bin/node server
Restart=always
# \/ Es wird dringend empfohlen, hier deinen eigenen Benutzer zu erstellen
User=root
Environment=NODE_ENV=production
# \/ Gib hier deinen Installationsort an
WorkingDirectory=/opt/myspeed
[Install]
WantedBy=multi-user.target
```
3. Speichere die Datei. Dies variiert je nach Editor.
::: code-group
```sh [nano]
Drücke `STRG` + `X`, dann drücke `Y` und drücke `Enter`, um die Datei zu speichern und den Editor zu verlassen.
```
```sh [vim]
Drücke `ESC`, tippe dann `:wq` und drücke `Enter`, um die Datei zu speichern und den Editor zu verlassen.
```
4. Lade nun systemd neu.
```sh
systemctl daemon-reload
```
5. Wenn du möchtest, dass MySpeed beim Start von systemd startet, gib diesen Befehl ein:
```sh
systemctl enable myspeed
```
6. Fertig! Jetzt kannst du MySpeed starten.
```sh
systemctl start myspeed
```
7. Überprüfe nun den Status von MySpeed.
```sh
systemctl status myspeed
```

View File

@@ -2,46 +2,57 @@
Here the setup for Linux is described. MySpeed can be installed in several ways.
## Installation with Docker
!!! help "Help"
You don't know how to install Docker? Then check out [this guide](https://docs.docker.com/engine/install/#server)
=== "Stable Version"
```sh
docker run -d -p 5216:5216 -v myspeed:/myspeed/data --restart=unless-stopped --name MySpeed germannewsmaker/myspeed
```
::: tip Help
You don't know how to install Docker? Then check out [this guide](https://docs.docker.com/engine/install/#server)
:::
=== "Development Version"
```sh
docker run -d -p 5216:5216 -v myspeed:/myspeed/data --restart=unless-stopped --name MySpeed germannewsmaker/myspeed:development
```
::: code-group
```sh [Stable Version]
docker run -d -p 5216:5216 -v myspeed:/myspeed/data --restart=unless-stopped --name MySpeed germannewsmaker/myspeed
```
```sh [Development Version]
docker run -d -p 5216:5216 -v myspeed:/myspeed/data --restart=unless-stopped --name MySpeed germannewsmaker/myspeed:development
```
:::
## Automatic installation
=== "Stable Version"
```sh
bash <(curl -sSL https://install.myspeed.dev)
```
::: code-group
=== "Development Version"
```sh
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/install.sh | bash -s -- --beta
```
```sh [Stable Version]
bash <(curl -sSL https://install.myspeed.dev)
```
```sh [Development Version]
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/install.sh | bash -s -- --beta
```
:::
## Automatic uninstall process
Don't want to use MySpeed anymore? You can easily remove MySpeed. Decide here if you want to keep or delete your data.
!!! warning "Execute these commands carefully"
Executing the commands will result in deletion / uninstallation of MySpeed. Please be aware of this.
::: warning Execute these commands with caution
Executing the commands will result in deletion / uninstallation of MySpeed. Please be aware of this.
:::
=== "Keep data"
```sh
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/uninstall.sh | bash -s -- --keep-data
```
::: code-group
=== "Delete data"
```sh
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/uninstall.sh | bash
```
```sh [Keep data]
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/uninstall.sh | bash -s -- --keep-data
```
```sh [Delete data]
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/uninstall.sh | bash
```
:::
## Manual installation
```sh
@@ -72,8 +83,10 @@ NODE_ENV=production node server #(7)
If you plan to run MySpeed in the background, see the guide below.
## Install MySpeed from the source code
!!! warning "Attention"
This process installs the latest development version of MySpeed. Errors may occur.
::: warning Attention
This process installs the latest development version of MySpeed. Errors may occur.
:::
```sh
sudo apt-get install git curl -y #(1)
@@ -104,8 +117,9 @@ NODE_ENV=production node server #(7)
## Install MySpeed 24/7
!!! warning "Important"
You have used the installation script? Then you don't need to do this step at all.
::: warning Important
You have used the installation script? Then you don't need to do this step at all.
:::
Installing as a system service is not even that hard. In this case we use `systemd`, because it is directly integrated in most Linux distributions.
@@ -115,7 +129,7 @@ Installing as a system service is not even that hard. In this case we use `syste
```
2. Now paste the content of the file.
```ini linenums="1"
```ini
[Unit]
Description=MySpeed
After=network.target
@@ -136,17 +150,21 @@ Installing as a system service is not even that hard. In this case we use `syste
3. Save the file. This varies a bit depending on the editor
=== "Nano"
`CTRL` + `X`, then `Y` and then `Enter`
=== "Vim"
Press `ESC`, then type `:wq` and press `Enter`
::: code-group
```sh [nano]
Press `CTRL` + `X`, then press `Y` and press `Enter` to save the file and exit the editor.
```
```sh [vim]
Press `ESC`, then type `:wq` and press `Enter` to save the file and exit the editor.
```
4. Now reload systemd
4. Now reload systemd
```sh
systemctl daemon-reload
```
5. If you want MySpeed to boot at systemd startup, type this command:
5. If you want MySpeed to boot at systemd startup, type this command:
```sh
systemctl enable myspeed
```

View File

@@ -1,161 +0,0 @@
# Einrichtung Linux
Hier wird die Einrichtung für Linux beschrieben. MySpeed lässt sich über verschiedene Wege installieren.
## Installation mit Docker
!!! help "Hilfe"
Du weißt nicht wie man Docker installiert? Dann schau dir mal [diese Anleitung](https://docs.docker.com/engine/install/#server) an
=== "Stabile Version"
```sh
docker run -d -p 5216:5216 -v myspeed:/myspeed/data --restart=unless-stopped --name MySpeed germannewsmaker/myspeed
```
=== "Entwicklungsversion"
```sh
docker run -d -p 5216:5216 -v myspeed:/myspeed/data --restart=unless-stopped --name MySpeed germannewsmaker/myspeed:development
```
## Automatische Installation
=== "Stabile Version"
```sh
bash <(curl -sSL https://install.myspeed.dev)
```
=== "Entwicklungsversion"
```sh
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/install.sh | bash -s -- --beta
```
## Automatischer Deinstallationsprozess
Keine Lust mehr? Du kannst MySpeed ganz einfach wieder entfernen. Entscheide hier, ob du deine Daten behalten oder löschen möchtest.
!!! warning "Führe diese Befehle mit Bedacht aus"
Das Ausführen der Befehle führt zur Löschung / Deinstallation von MySpeed. Sei dir bitte dessen bewusst.
=== "Daten behalten"
```sh
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/uninstall.sh | bash -s -- --keep-data
```
=== "Daten löschen"
```sh
curl -sSL https://raw.githubusercontent.com/gnmyt/myspeed/development/scripts/uninstall.sh | bash
```
## Manuelle Installation
```sh
sudo apt-get install wget curl unzip -y #(1)
# Dies brauchst du nur ausführen, wenn du NodeJS noch nicht installiert hast
curl -sSL https://deb.nodesource.com/setup_18.x | bash
sudo apt-get install nodejs -y #(2)
mkdir /opt/myspeed && cd /opt/myspeed #(3)
wget $(curl -s https://api.github.com/repos/gnmyt/myspeed/releases/latest | grep browser_download_url | cut -d '"' -f 4) #(4)
unzip MySpeed-*.zip && rm MySpeed-*.zip #(5)
npm install #(6)
NODE_ENV=production node server #(7)
```
1. Hier installierst du alle notwendigen Pakete, um das Projekt zu installieren.
2. Dieser Schritt installiert die neuste Version von NodeJS.
3. Erstelle nun den Ordner, in welchen du MySpeed installieren möchtest. In diesem Fall ist das der Ordner `/opt/myspeed`.
4. Jetzt installierst du dir die neuste Version von MySpeed.
5. Nun entpackst du die gerade heruntergeladene Datei (dann kannst du sie löschen)
6. Installiere nun alle Abhängigkeiten.
7. Jetzt wird MySpeed gestartet. MySpeed ist nun unter dem Port 5216 erreichbar.
Wenn du planst, MySpeed im Hintergrund laufen zu lassen, dann schau dir den Guide dafür unten an.
## MySpeed vom Source-Code installieren
!!! warning "Achtung"
Dieser Prozess installiert die neuste Entwicklungsversion von MySpeed. Fehler können auftreten.
```sh
sudo apt-get install git curl -y #(1)
# Dies brauchst du nur ausführen, wenn du NodeJS noch nicht installiert hast
curl -sSL https://deb.nodesource.com/setup_18.x | bash
sudo apt-get install nodejs -y #(2)
mkdir /opt/myspeed && cd /opt/myspeed #(3)
git clone https://github.com/gnmyt/myspeed.git . #(4)
npm install #(5)
cd client && npm install && npm run build && cd .. && mv client/build . #(6)
NODE_ENV=production node server #(7)
```
1. Hier installierst du alle notwendigen Pakete, um das Projekt zu installieren.
2. Dieser Schritt installiert die neuste Version von NodeJS.
3. Erstelle nun den Ordner, in welchen du MySpeed installieren möchtest. In diesem Fall ist das der Ordner `/opt/myspeed`.
4. Klone nun das MySpeed Repository, um Zugriff auf den Code zu erhalten.
5. Installiere nun alle Abhängigkeiten des Servers.
6. Jetzt kompilierst du die Oberfläche von MySpeed und verschiebst sie in den Ordner wo MySpeed sie lesen kann.
7. Jetzt wird MySpeed gestartet. MySpeed ist nun unter dem Port 5216 erreichbar.
Wenn du planst, MySpeed im Hintergrund laufen zu lassen, dann schau dir den Guide dafür unten an.
## MySpeed 24/7 installieren
!!! warning "Wichtig"
Du hast das Installationsskript verwendet? Dann brauchst du diesen Schritt gar nicht mehr ausführen.
Die Installation als Systemdienst ist gar nicht mal so schwer. In diesem Fall nutzen wir `systemd`, weil es direkt in den meisten Linux-Distributionen integriert ist.
1. Erstelle eine Datei mit dem Namen `myspeed.service` unter `/etc/systemd/system`. Hier verwenden wir `nano`
```sh
nano /etc/systemd/system/myspeed.service
```
2. Füge nun den Inhalt der Datei ein.
```ini linenums="1"
[Unit]
Description=MySpeed
After=network.target
[Service]
Type=simple
ExecStart=/usr/bin/node server
Restart=always
# \/ Es wird stark empfohlen, einen eigenen Nutzer hier zu erstellen
User=root
Environment=NODE_ENV=production
# \/ Gib hier deinen Installationsort an
WorkingDirectory=/opt/myspeed
[Install]
WantedBy=multi-user.target
```
3. Speicher die Datei ab. Das variiert je nach Editor ein wenig
=== "Nano"
`STRG` + `X`, dann `Y` und dann `Enter`
=== "Vim"
Drücke `ESC`, gib dann `:wq` ein und drücke `Enter`
4. Lade nun systemd neu
```sh
systemctl daemon-reload
```
5. Wenn du möchtest, dass MySpeed beim Systemstart hochfährt, gib diesen Befehl ein:
```sh
systemctl enable myspeed
```
6. Fertig! Nun kannst du MySpeed endlich starten.
```sh
systemctl start myspeed
```
7. Überprüfe jetzt noch am besten den Status von MySpeed
```sh
systemctl status myspeed
```