Played around

Änderungen am Code

• .gitlab-ci.yml: Images für alle Branches bauen (@tmueller)
• Dockerfile: Variablen für PaperMC-User und PaperMC-Group eingefügt und überall verwendet
• Dockerfile: chmod nicht mehr nötig, da die Dateien eh schon ausführbar im Git liegen
• Dockerfile: Skriptdateien werden direkt nach /, nicht nach . (was in unserem Fall sowieso der Root ist) kopiert
• Dockerfile und papermc.sh: wget überall durch curl ersetzt, Dependency entfernt
• papermc.sh: baseUrl und auth als Konfigurationsvariablen an den Anfang geschrieben
• papermc.sh: Im Namen der JAR-Datei papermc durch paper ersetzt, damit man die Variable JAR_NAME sowohl in der URL als auch zum Starten der heruntergeladenen Datei verwenden kann
• health.sh hinzugefügt und healtcheck im dockerfile benutzt

Änderungen an Dokumentation etc.

• .gitlab-ci.yml: Bessere Quelleangabe
• backup.sh, restore.sh, health.sh, backup.sh und papermc.sh: Als ausführbar markiert
• Dockerfile: Dokumentationskommentare eingefügt
• Dockerfile: /papermc und /backup werden in einer Zeile ausgeführt
• Dockerfile: Apt-get-Dependencies zeilenweise aufgelistet, damit es später mal bei Merge Requests einfacher wird, Änderungen zu sehen
• papermc.sh: Dokumentationskommentare eingefügt
• papermc.sh: Einrückungen mit Tabs im unteren Teil der Datei durch Spaces ersetzt (damit konsistent)

Grundlegende Tests die bestanden werden müssen

• Healthcheck sollte ein healthy bzw exit code 0 zurückgeben
• latest.log sollte in der letzten Zeile Timings Reset beinhalten (testscript folgt noch, das ist aber eher ein milestone)

Testbedingungen: am besten eine Debian VM sodass manuelle Änderungen an den Rechten o. ä. nicht die Ergebnisse verfälschen Innerhalb des Containers kann per console die test.sh ausgeführt werden um die Tests auszuführen

Optionale Tests, deren Priorität zweitrangig sind

• Dynmap webserver files sind für webserver lesbar und .json files beschreibbar (Chatfunktion)
• backup.sh kann von EssentialsX (Plugin) gestartet werden.

Dockerfile

@@ -32,7 +32,10 @@ RUN chown -R ${papermc_user} /papermc
 RUN chown -R ${papermc_user} /backup
 
 # Get package lists, install needed packages, then remove the package lists again (to save space)
-# "webp" is needed to generate images with better compression for the dynamic map
+# "webp" is needed to generate images with better compression for the dynamic map (optional, needs further configuration in dynmap-plugin´s config file)
+# "cron" is for making it possible to restart the server every day, week or soemthing similar (its optional)
+# "curl" is required for getting the server initialised
+# "screen" is required for getting the server running at all
 RUN apt-get update && apt-get install -y \
     cron \
     curl \
@@ -44,15 +47,16 @@ RUN apt-get update && apt-get install -y \
 # Execute all following commands as the papermc user
 USER $papermc_user
 
-# Start script
+# Start script and also entrypoint for the container
 CMD ["sh", "/papermc.sh"]
 
 #Alle 10s testen ob exit code = 0
 HEALTHCHECK --interval=10s --timeout=10s --start-period=30s \ 
     CMD ["sh", "/health.sh"]
 
-# Container setup
+# Container setup, specifies needed ports. May be adjusted or overwritten if plugins need other ports
 EXPOSE 25565/tcp
 EXPOSE 25565/udp
+#Specifies the datastructure in the container
 VOLUME /papermc
 VOLUME /backup