Installation

AbiPlaner ist als moderne Docker-basierte Anwendung konzipiert. Dies garantiert, dass die Anwendung auf jedem System identisch läuft – egal ob auf einem kleinen Schulserver, in der Cloud oder auf Ihrem lokalen Rechner.

1 Voraussetzungen prüfen

Bevor Sie starten, stellen Sie sicher, dass Ihr Server folgende Anforderungen erfüllt:

  • Betriebssystem: Ubuntu 22.04 LTS (empfohlen), Debian 11+, oder macOS.
  • Software: Git, Docker und Docker Compose (Plugin).
  • Hardware: Min. 2 GB RAM, 20 GB Speicher.
  • Domains (Optional): Eine Domain, die auf die IP Ihres Servers zeigt (für SSL via Traefik).

2 Installation starten

Wir haben den gesamten Prozess in einem interaktiven Skript automatisiert. Verbinden Sie sich per SSH mit Ihrem Server und führen Sie folgende Befehle aus:

Terminal
# 1. Repository klonen git clone https://github.com/wtrinkl/abiplaner.git && cd abiplaner # 2. Installer ausführbar machen & starten chmod +x install.sh && ./install.sh

Hinweis: Das Skript fragt Sie interaktiv nach Konfigurationen (z.B. ob Sie Traefik als Reverse Proxy nutzen wollen oder ob PhpMyAdmin installiert werden soll).

3 Nach der Installation

Nach erfolgreicher Installation ist die Anwendung unter Ihrer Domain (oder http://localhost:8080) erreichbar.

Loggen Sie sich mit dem während der Installation erstellen Super-Admin Account ein, um Schulen, Lehrer und Schüler anzulegen.

Häufige Aufgaben

Updates einspielen

Nutzen Sie das Skript, um Updates sicher einzuspielen (inkl. Datenbank-Migrationen):

./install.sh --update

Backup erstellen

Datenbank-Dumps können via Docker erstellt werden:

docker compose exec db mysqldump -u abiplaner -p abiplaner > backup.sql