m158/docs/panel/README.md

125 lines
5.5 KiB
Markdown
Raw Normal View History

2024-07-04 16:23:53 +00:00
# Realisieren: Panel
## Inhaltsverzeichnis
2024-07-10 21:05:38 +00:00
- [Inhaltsverzeichnis](#inhaltsverzeichnis)
- [LXC Container](#lxc-container)
- [Docker Image und Compose vorbereiten](#docker-image-und-compose-vorbereiten)
- [Deployment vom Panel](#deployment-vom-panel)
- [2FA](#2fa)
- [Reverse Proxy](#reverse-proxy)
- [Probleme](#probleme)
2024-07-04 16:23:53 +00:00
2024-07-05 13:31:07 +00:00
## LXC Container
Das Panel wird in einem bereits bestehenden LXC Container installiert. Auf diesem Container sind noch weitere Webapplikationen in Container gehostet und das Panel integriert sich dort gut. Deswegen haben wir keinen weiteren LXC Container erstellt, da es nur Ressourcenverschwendung gewesen wäre.
2024-07-04 16:23:53 +00:00
2024-07-04 19:19:28 +00:00
## Docker Image und Compose vorbereiten
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.
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.
```yaml
x-common:
database:
&db-environment
# Do not remove the "&db-password" from the end of the line below, it is important
# for Panel functionality.
MYSQL_PASSWORD: &db-password "<redacted>"
MARIADB_RANDOM_ROOT_PASSWORD: 1
panel:
&panel-environment
APP_URL: "http://nugget.sangelo.space"
APP_TIMEZONE: "Europe/Zurich"
APP_SERVICE_AUTHOR: "no-reply@lunivity.com"
APP_BACKUP_DRIVER: wings
PTERODACTYL_TELEMETRY_ENABLED: false
mail:
&mail-environment
MAIL_FROM: "no-reply@lunivity.com"
MAIL_DRIVER: "smtp"
MAIL_HOST: "mail.lunivity.com"
MAIL_PORT: "587"
MAIL_USERNAME: "no-reply@lunivity.com"
MAIL_PASSWORD: "<redacted>"
MAIL_ENCRYPTION: "true"
```
2024-07-04 16:23:53 +00:00
## Deployment vom Panel
2024-07-04 19:19:28 +00:00
Mit Docker Compose ist das grundlegende Deployment sehr simpel. Danach muss man aber noch einige Konfigurationen vornehmen. Die wichtigste ist die Erstellung des ersten Benutzers:
```bash
[miliena@panel ~]$ docker exec -it 381baf0abc0b sh
/app # php artisan p:user:make
Is this user an administrator? (yes/no) [no]:
> yes
Email Address:
> test@example.com
Username:
> admin
First Name:
> First
Last Name:
> Last
Passwords must be at least 8 characters in length and contain at least one capital letter and number.
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 |
+----------+--------------------------------------+
| UUID | 360f93fc-0370-4ef4-b0f0-a818f471c6f2 |
| Email | test@example.com |
| Username | admin |
| Name | First Last |
| Admin | Yes |
+----------+--------------------------------------+
```
Die erste Benutzereinrichtung wird über die Commandline im Container vorgenommen. Danach können Benutzer einfach über das Webinterface eingerichtet werden.
2024-07-04 16:23:53 +00:00
### 2FA
2024-07-04 19:19:28 +00:00
Sobald das Panel live ist, kann man mit einem Administratorenkonto unter "Admin Control" am folgenden Ort 2FA aktivieren.
> [!CAUTION]
> Dies erzwingt 2FA sofort auch für den angemeldeten Accounts
2024-07-04 19:19:28 +00:00
![basic administration -> settings -> general -> "Require 2-Factor Authentication" to "All Users"](../../assets/panel/enable-2fa.png)
2024-07-10 21:05:38 +00:00
## Reverse Proxy
Das Caddyfile leitet alle Anfragen an `nugget.sangelo.space` über einen Reverse-Proxy an den Server `10.1.30.1:2080` weiter und sagt Caddy es soll die IP und location des Host auch mit sended um die standart Konfiguration von Caddy ignorieren.
```Caddy
nugget.sangelo.space {
2024-07-10 21:05:38 +00:00
reverse_proxy https://10.1.30.1:2443 {
header_up X-Real-IP {remote_host}
header_up X-Forwarded-For {remote_host}
header_up Host {upstream_hostport}
}
}
2024-07-09 19:40:26 +00:00
```
## Probleme
Nach dem Deployen vom Panel hatten wir das Problem, dass nach jeder Änderung im Panel ein Server Error 500 aufgetaucht ist. Dank einem [offenen Issue](https://github.com/pterodactyl/panel/issues/5051) haben wir erkannt, dass es sich um ein Berechtigungsfehler im Container handelt.
Nachdem wir beim erneuten Deployment folgenden Befehl `docker compose exec panel chown -R nginx: /app/storage/logs/` verwendet haben, hat alles funktioniert.
2024-07-10 06:37:50 +00:00
Dieser Befehl ändert den Besitzer der Ordners `/app/storage/logs` auf den User Nginx, was nötig ist, da der Webserver ansonsten keine Logs schreiben kann.