- If you want to update from a BlueSpice version < 4.4, the intermediate step of updating to 4.4 is required.
- If you want to update from a Docker container 4.4 to 5.1, first update to 4.5.
Determine your update scenario
With version 4.5 of BlueSpice, there were two options for installation:
Container stack (bluespice-deploy)
If you have already installed BlueSpice 4.5 as a Docker container, follow the update instructions below to BlueSpice 5:
→ Upgrade from bluespice-deploy installation
Direct installation (classic tarball)
If you have already installed BlueSpice 4.5 as a Docker container, follow the update instructions below to BlueSpice 5:
→ Upgrade from classic tarball installation
Based on which of those you are starting from, the update to BlueSpice version 5.1 may require different steps.
Special cases
Before running the database schema updates, based on the previously installed edition of BlueSpice and optionally enabled extensions, some minor changes on the database may be required.
Extension:OATHAuth
In some cases the extension tables must be added manually to the database before the update.
Extension:OpenIDConnect
In some cases this patch needs to be applied before the update.
ALTER TABLE openid_connect DROP COLUMN oidc_id;
ALTER TABLE openid_connect ADD PRIMARY KEY (oidc_user);
openid_connect table contains duplicate entries of oidc_subject, you can safely remove all duplicates, that have a tailing slash in the oidc_issuer field.
External MySQL/MariaDB database
If your wiki uses an external database server before update, and you plan to continue using the same external database server after the update, make sure that the task runner processes of your wiki before update are completely shut down:
- For 4.5 installations with Docker containers, make sure that:
- the previous stack is stopped
- its daemon service
bluespice.serviceis removed/disabled - the containers in the previous stack are down, and will not start automatically upon server restart
- For 4.5 installations directly within the Linux system of the host machine:
- check the Crontab attributes for your root user, comment out job runner / process runner lines
- check and end remaining processes
Collabpads database update
The easiest way to update from MongoDB 4.4 to 8.0 is to export and import the databases:
Example:
On Mongo 4.4 run
mongodump --db <dbname> --gzip --archive > /tmp/collabpads_dump.gz
On Mongo 8.0 run
mongorestore --gzip --archive=/tmp/collabpads_dump.gz
SAML authentication
If you were using SAML with the previous version of BlueSpice, you will probably need to re-register the Service Provider with your Identity Provider.
To do so, download the new metadata.xml file from https://<wikiserver>/_sp/module.php/saml/sp/metadata.php/default-sp
