Zum Hauptinhalt springen

Get Started

Voraussetzungen​

Bevor du beginnst, stelle sicher, dass dein System die folgenden Anforderungen erfüllt.

Systemanforderungen​

  • RAM: Mindestens 2 GB
  • CPU: Mindestens 2 Kerne

Benötigte Software​

  • Git – zum Klonen des Repositories
  • Docker & Docker Compose – zum Starten der Anwendung
  • Docker installieren
  • Docker Compose ist ab Docker Desktop bereits enthalten

Schritt 1: Docker installieren​

Falls Docker noch nicht installiert ist, lade es von der offiziellen Seite herunter und installiere es:

👉 https://docs.docker.com/get-docker/

Überprüfe nach der Installation, ob Docker korrekt funktioniert:

docker --version
docker compose version

Schritt 2: Projekt installieren und ausführen​

  1. Herunterladen der Konfigurations- & Installationsdateien
curl -O https://raw.githubusercontent.com/uni-verein/uni-verein/refs/tags/1.1.0/nginx.conf
curl -O https://raw.githubusercontent.com/uni-verein/uni-verein/refs/tags/1.1.0/docker-compose-ini.yml
curl -O https://raw.githubusercontent.com/uni-verein/uni-verein/refs/tags/1.0.0/docker-compose-prod-image.yml
  1. Erzeugen der Umgebungsvariablen in der .env-Datei
touch .env && mkdir backup && docker compose -f docker-compose-ini.yml up

Bearbeite die .env-Datei und ändere die Datenbank-Passwörter:

DB_ROOT_PASSWORD=rootUserPassword
DB_NAME=uni-verein
DB_USER=databaseUserName
DB_PASSWORD=databaseUserPassword
  1. Starten der Anwendung
docker compose -f docker-compose-prod-image.yml up -d

Die Anwendung ist anschließend unter http://localhost:80 erreichbar. 🎉

Um die laufenden Container zu überprüfen:

docker compose ps

Um die Logs einzusehen:

docker compose logs -f

Aktualisierung​

Als Administrator siehst du eine Benachrichtigungsglocke in der App, sobald eine neue Version verfügbar ist. Erstelle vor dem Update ein manuelles Backup (Datenbank-Backup und Mitgliederexport, beide verfügbar unter Backup in der App). Führe dann Folgendes aus deinem Installationsverzeichnis aus (dem Verzeichnis, das die .env enthält):

curl -O https://raw.githubusercontent.com/uni-verein/uni-verein/main/docker-compose-update.yml
docker compose -f docker-compose-update.yml run --rm update

Dies prüft GitHub auf die neueste Version und bittet dich zu bestätigen, dass du ein manuelles Backup erstellt hast — das Update wird erst fortgesetzt, wenn du yes eingibst. Anschließend werden die passende nginx.conf und docker-compose-prod-image.yml heruntergeladen, VERSION in deiner .env aktualisiert und der Stack mit der neuen Version neu gestartet. Deine bestehenden Secrets und die Datenbank bleiben unverändert.