APBoard v3 · Dokumentation

Dokumentation

Alles was du brauchst, um APBoard zu installieren, zu konfigurieren und zu betreiben – ausführlich erklärt, auch für absolute Einsteiger.

APBoard Dokumentation Aktualisieren

APBoard aktualisieren

Neue APBoard-Versionen bringen Bugfixes, Sicherheitspatches und neue Features. Der Update-Prozess ist einfach und dauert nur wenige Minuten.

Backup vor jedem Update

Erstelle immer ein Backup bevor du aktualisierst — auch bei kleineren Updates. Lies die Backup-Checkliste unten bevor du beginnst.

Vor dem Update: Backup-Checkliste

  • Datenbank-Dump erstellt
  • storage/-Verzeichnis gesichert (Uploads, Logs)
  • .env-Datei gesichert
  • Benutzerdefinierte Anpassungen (Themes, Templates) gesichert
  • Changelog gelesen — Breaking Changes bekannt?

Datenbank-Backup erstellen

bash
# Docker-Installation:
docker compose exec db mysqldump -u root -p apboard > backup-$(date +%Y%m%d).sql

# LAMP-Installation:
mysqldump -u apboard -p apboard > backup-$(date +%Y%m%d).sql

Update mit Docker

Docker-Updates sind schnell und sicher. APBoard führt Datenbank-Migrationen automatisch aus.

  1. 1
    Backup erstellen

    Siehe Checkliste oben.

  2. 2
    Neuesten Code holen
    bash
    cd /opt/apboard   # oder dein APBoard-Verzeichnis
    git pull
  3. 3
    Container neu bauen und starten
    bash
    docker compose up -d --build

    Docker baut den APBoard-Container neu und startet ihn. Beim Start werden automatisch alle ausstehenden Datenbank-Migrationen ausgeführt.

  4. 4
    Prüfen ob alles läuft
    bash
    docker compose ps
    docker compose logs apboard | tail -20
Das war's!

Bei Docker ist der Update-Prozess damit abgeschlossen. Öffne das Forum und prüfe ob alles wie erwartet funktioniert.

Update auf LAMP

Bei LAMP-Installationen musst du die Dateien manuell ersetzen.

  1. 1
    Backup erstellen und Changelog lesen

    Lies die Changelog-Notizen für dein Update auf GitLab — besonders auf Breaking Changes achten.

  2. 2
    Neues Release-ZIP herunterladen
    bash
    cd /tmp
    wget https://gitlab.apboard.de/app/apboard3/-/releases/permalink/latest/downloads/apboard3-release.zip
    unzip apboard3-release.zip -d /tmp/apboard-update
  3. 3
    Dateien ersetzen (ohne config/ und storage/)
    bash
    # Dateien kopieren, aber config/ und storage/ auslassen
    rsync -av --exclude='config/' --exclude='storage/'   /tmp/apboard-update/ /var/www/forum/
    
    # Dateirechte neu setzen
    sudo chown -R www-data:www-data /var/www/forum
    sudo find /var/www/forum -type f -exec chmod 644  \;
    sudo find /var/www/forum -type d -exec chmod 755  \;
    sudo chmod -R 775 /var/www/forum/storage
    sudo chmod -R 775 /var/www/forum/bootstrap/cache
  4. 4
    Datenbank-Migrationen ausführen
    bash
    cd /var/www/forum
    php artisan migrate --force
  5. 5
    Cache leeren
    bash
    php artisan cache:clear
    php artisan config:clear
    php artisan view:clear

Was bei einem Update automatisch passiert

APBoard verwaltet Datenbankänderungen über sogenannte Migrationen. Das sind versionierte SQL-Änderungsskripte, die beim Start automatisch ausgeführt werden, wenn neue Spalten oder Tabellen benötigt werden.

Du musst Migrationen nicht manuell schreiben oder ausführen — das passiert automatisch.

  • Neue Tabellen werden erstellt
  • Spalten werden hinzugefügt
  • Bestehende Daten bleiben unberührt
  • Bereits ausgeführte Migrationen werden nicht erneut ausgeführt
Hinweis zu Major-Versionen

Bei Major-Versionen (z.B. von v3.x auf v4.x) können Breaking Changes auftreten. Lies in diesem Fall die spezifischen Upgrade-Hinweise im Changelog auf GitLab. Minor- und Patch-Updates (v3.1 → v3.2, v3.2.1 → v3.2.2) sind immer rückwärtskompatibel.

Rollback im Notfall

Falls nach einem Update Probleme auftreten:

bash
# Docker: zurück zur vorherigen Version
git log --oneline -5   # letzte Commits anzeigen
git checkout COMMIT-HASH
docker compose up -d --build

# Datenbank-Backup zurückspielen falls nötig:
docker compose exec -T db mysql -u root -p apboard < backup-DATUM.sql