APBoard v3 · Documentation

Documentation

Everything you need to install, configure and run APBoard – explained in full, even for complete beginners.

APBoard › Documentation › Update APBoard

Update APBoard

New APBoard versions bring bug fixes, security patches and new features. The update process is simple and takes only a few minutes.

Backup before every update

Always create a backup before updating – even for minor updates. Read the backup checklist below before you start.

Before the update: backup checklist

  • Database dump created
  • storage/ directory backed up (uploads, logs)
  • .env file backed up
  • Custom changes (themes, templates) backed up
  • Changelog read – breaking changes noted?

Create database backup

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 with Docker

  1. 1
    Create backup

    See checklist above.

  2. 2
    Fetch latest code
    bash 
    cd /opt/apboard
git pull
  3. 3
    Rebuild and start containers
    bash 
    docker compose up -d --build

    Docker rebuilds the APBoard container and starts it. On start, all pending database migrations are automatically executed.

  4. 4
    Check everything is running
    bash 
    docker compose ps
docker compose logs apboard | tail -20
That’s it!

With Docker the update process is complete. Open the forum and check everything works as expected.

Update on LAMP

  1. 1
    Create backup and read changelog

    Read the changelog notes for your update on GitLab – pay special attention to breaking changes.

  2. 2
    Download new release ZIP
    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
    Replace files (leave config/ and storage/ alone)
    bash 
    rsync -av --exclude='config/' --exclude='storage/' /tmp/apboard-update/ /var/www/forum/
sudo chown -R www-data:www-data /var/www/forum
  4. 4
    Run database migrations
    bash 
    cd /var/www/forum
php artisan migrate --force
  5. 5
    Clear cache
    bash 
    php artisan cache:clear
php artisan config:clear
php artisan view:clear

Rollback in an emergency

bash 
# Docker: go back to previous version
git log --oneline -5
git checkout COMMIT-HASH
docker compose up -d --build

# Restore database backup if necessary:
docker compose exec -T db mysql -u root -p apboard < backup-DATE.sql
Back Getting started Next Troubleshooting