tbz/m158
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[c] formatting and changes

Browse source
This commit is contained in:
Sangelo 2024-07-11 20:18:31 +02:00
parent c22775fa7d
commit ccdbf27ec6
3 changed files with 31 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
docs/README.md
View file

@ -2,26 +2,25 @@
## Inhaltsverzeichnis
- [Modul 158: Softwaremigration Planen und Durchführen](#modul-158-softwaremigration-planen-und-durchführen)
- [Inhaltsverzeichnis](#inhaltsverzeichnis)
- [Einleitung](#einleitung)
- [Informieren](#informieren)
- [Planen](#planen)
- [Ziele](#ziele)
- [Must-have](#must-have)
- [Nice to have](#nice-to-have)
- [Low priority](#low-priority)
- [To-do](#to-do)
- [Panel](#panel)
- [Wings](#wings)
- [Post-Installation](#post-installation)
- [Migrationsplan](#migrationsplan)
- [Serverressourcen](#serverressourcen)
- [Entscheiden](#entscheiden)
- [Realisieren](#realisieren)
- [Kontrollieren](#kontrollieren)
- [Testen](#testen)
- [Auswerten](#auswerten)
- [Inhaltsverzeichnis](#inhaltsverzeichnis)
- [Einleitung](#einleitung)
- [Informieren](#informieren)
- [Planen](#planen)
- [Ziele](#ziele)
- [Must-have](#must-have)
- [Nice to have](#nice-to-have)
- [Low priority](#low-priority)
- [To-do](#to-do)
- [Panel](#panel)
- [Wings](#wings)
- [Post-Installation](#post-installation)
- [Migrationsplan](#migrationsplan)
- [Serverressourcen](#serverressourcen)
- [Entscheiden](#entscheiden)
- [Realisieren](#realisieren)
- [Kontrollieren](#kontrollieren)
- [Testen](#testen)
- [Auswerten](#auswerten)
## Einleitung
@ -162,13 +161,13 @@ TODO: update this table of contents once docs are finished
### Testen
| ID | Testaspekte | Testbeschreibung | Erwartetes Resultat | Tatsächliches Resultat |
|-----|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|
| 1.1 | Panel (Admin), Reverse Proxy, 2FA | Der Zugriff auf das Panel mit einem Administratorenkonto soll versucht werden. | Der Zugriff sollte problemlos funktioneren und es sollte nach dem OTP fragen. Zusätzlich sollten alle Administratorfunktionen verfügbar sein. | |
| 1.2 | Panel (non Admin), Reverse Proxy, 2FA | Der Zugriff auf das Panel mit einem normalen Konto soll versucht werden. | Der Zugriff sollte problemlos funktionieren und es sollte nach dem OTP fragen. Zusätzlich sollten keine Administratorfunktionen verfügbar sein. | |
| 2.1 | Wings als Backend, Reverse Proxy | Der Zugriff auf Wings sollte nur über das Panel funktionieren. Im Browser soll man den Namen von Wings aufrufen. | Es sollte kein GUI im Browser erscheinen | |
| 2.2 | Wings als Backend, Reverse Proxy | Der Zugriff auf Wings sollte nur über das Panel funktionieren. Im Panel soll man kontrollieren, ob die Node verbunden ist. | Im Panel sollte die Node auffindbar sein. | |
| 2.3 | Minecraft Server, Reverse Proxy | Der Zugriff auf Wings sollte über einen Game Launcher funktionieren. In einem Minecraft Launcher sollte man den Namen von Wings aufrufen. | Es sollte ein Minecraft Server auffrufbar sein unter dem Namen von Wings. | |
| 3.1 | Minecraft Server, Migration | Die fehlerfreie Übertragung der Minecraft Welten sollte erfolgreich abgeschlossen sein. Mit einem Laden einer ausgewählten Welt kann dies nachvollzogen werden. | Die übertragenen Welten des Minecraft Servers sollten ohne Schaden migriert sein. | |
| ID | Testaspekte | Testbeschreibung | Erwartetungen | Resultat |
| --- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | :------: |
| 1.1 | Panel (Admin), Reverse Proxy, 2FA | Der Zugriff auf das Panel mit einem Administratorenkonto soll versucht werden. | Der Zugriff sollte problemlos funktioneren und es sollte nach dem OTP fragen. Zusätzlich sollten alle Administratorfunktionen verfügbar sein. | ✅ |
| 1.2 | Panel (non Admin), Reverse Proxy, 2FA | Der Zugriff auf das Panel mit einem normalen Konto soll versucht werden. | Der Zugriff sollte problemlos funktionieren und es sollte nach dem OTP fragen. Zusätzlich sollten keine Administratorfunktionen verfügbar sein. | |
| 2.1 | Wings als Backend, Direkt (IP oder Domain) | Der Zugriff auf Wings sollte nur über das Panel funktionieren. Im Browser soll man den Namen von Wings aufrufen. | Kein Zugriff auf API | |
| 2.2 | Wings als Backend, Direkt (IP oder Domain) | Der Zugriff auf Wings sollte nur über das Panel funktionieren. Im Panel soll man kontrollieren, ob die Node verbunden ist. | Im Panel sollte die Node auffindbar und erreichbar sein. | |
| 2.3 | Minecraft Server, Direkt (IP oder Domain) | Der Zugriff auf Wings sollte über einen Game Launcher funktionieren. In einem Minecraft Launcher sollte man den Namen von Wings aufrufen. | Es sollte ein Minecraft Server auffrufbar sein unter der IP/Domain von Wings. | |
| 3.1 | Minecraft Server, Migration | Die fehlerfreie Übertragung der Minecraft Welten sollte erfolgreich abgeschlossen sein. Mit einem Laden einer ausgewählten Welt kann dies nachvollzogen werden. | Die übertragenen Welten des Minecraft Servers sollten ohne Schaden migriert sein. | |
## Auswerten

6
docs/panel/README.md
View file

@ -18,11 +18,11 @@ Das Panel wird in einem bereits bestehenden LXC Container installiert. Auf diese
Auf [Docker Hub](https://hub.docker.com/) gibt es kein offizielles Docker Image vom Panel für Pterodactyl. Das [Github Repo](https://github.com/pterodactyl/panel) beinhaltet jedoch ein [Docker Image](https://github.com/pterodactyl/panel/pkgs/container/panel/213438609?tag=latest), welches auch direkt mit einer Beispiel Compose kommt.
Das Deployment wird mit Docker Compose gemacht. Das [Github Repo](https://github.com/pterodactyl/panel) hat bereits eine sehr gute Beispielkonfiguration. Diese haben wir etwas angepasst, da noch gewisse Credentials benötigt werden. Wir haben der Datenbank ein zufälliges Root-Passwort gegeben, da wir nur das User-Passwort verwenden müssen.
Das Deployment wird mit Docker Compose gemacht. Das [Github Repo](https://github.com/pterodactyl/panel) hat bereits eine sehr gute Beispielkonfiguration. Diese haben wir etwas angepasst, da noch gewisse Credentials benötigt werden. Wir haben der Datenbank ein zufälliges Root-Passwort gegeben, da wir nur das User-Passwort verwenden müssen.
Dem Panel haben wir noch die richtige HTTP-Adresse angegeben. HTTPS werden wir anschliessend mit dem Reverse Proxy umsetzen. Auch haben wir die korrekte Zeitzone und Email-Adresse gegeben. Zusätzlich haben wir noch Backups nach Wings aktiviert, diese müssen aber noch weiter konfiguriert werden und sind nicht Teil dieser Projektarbeit. Der letzte Punkt deaktiviert noch die Datensammlung von Pterodactyl, die zur Weiterentwicklung der Applikation dient.
Der Mailservice wird benötigt damit die "Forgot Password"-Funktion funktioniert. Unter der Adresse "no-reply@lunivity.com" wird dann ein Link verschickt um das Passwort zurückzusetzen. Dafür muss man natürlich auch noch Angaben wie Protokoll, Host und Port auf dem zu benutzenden Mailserver machen.
Der Mailservice wird benötigt damit die "Forgot Password"-Funktion funktioniert. Unter der Adresse `no-reply@lunivity.com` wird dann ein Link verschickt um das Passwort zurückzusetzen. Dafür muss man natürlich auch noch Angaben wie Protokoll, Host und Port auf dem zu benutzenden Mailserver machen.
```yaml
x-common:
@ -77,7 +77,7 @@ Passwords must be at least 8 characters in length and contain at least one capit
If you would like to create an account with a random password emailed to the user, re-run this command (CTRL+C) and pass the `--no-password` flag.
Password:
>
> ************
+----------+--------------------------------------+
| Field | Value |

2
docs/panel/docker-compose.yml
View file

@ -12,7 +12,7 @@ x-common:
APP_SERVICE_AUTHOR: "no-reply@lunivity.com"
APP_BACKUP_DRIVER: wings
PTERODACTYL_TELEMETRY_ENABLED: false
LE_EMAIL: "letsencrypt@lunivity.com"
# LE_EMAIL: "letsencrypt@lunivity.com"
mail:
&mail-environment
MAIL_FROM: "no-reply@lunivity.com"