Update from 4.5 to 5.1

With version 4.5 of BlueSpice, there were two options for installation:

1. bluespice-deploy container stack
2. Classic tarball

Based on which of those you are starting from, the update to BlueSpice version 5.1 may require different steps.

Create a backupBefore performing any of the following steps, make sure to make a backup of all databases and filesystem locations related to the process.

Updating from bluespice-deploy:4.5

Please read this guide carefully, before starting the update process.

DATADIR of bluespice/wiki container

There were some smaller changes in the directory layout. This sections describes the differences and explains required actions.

DATADIR of bluespice/wiki:4.5DATADIR of <code>bluespice/wiki:5.1Main differences

.
├── adminPassword
├── bluespice
│   ├── _sf_archive/
│   ├── _sf_instances/
│   ├── extensions
│   │   └── BlueSpiceFoundation
│   │       └── data/
│   ├── images/
│   ├── logs/
│   ├── post-init-settings.php
│   └── pre-init-settings.php
└── simplesamlphp
    ├── cache/
    ├── certs
    │   ├── saml.crt
    │   └── saml.pem
    ├── data/
    └── logs/

.
├── bluespice
│   ├── cache
│   ├── extensions
│   │   └── BlueSpiceFoundation
│   │       └── data/
│   ├── farm-archives/
│   ├── farm-instances/
│   ├── images/
│   ├── logs/
│   ├── oauth_private.key
│   ├── oauth_public.key
│   ├── post-init-settings.php
│   └── pre-init-settings.php
├── initialAdminPassword
└── simplesamlphp
    ├── cache/
    ├── certs/
    │   ├── saml.crt
    │   └── saml.pem
    ├── data/
    └── logs/

1. ./adminPassword is now called ./initialAdminPassword
   → You can safely ignore this in the update case. The admin password is stored in the database and will not change during the update
2. ./bluespice/_sf_archive/ and ./bluespice/_sf_instances/ are now called ./bluespice/farm-instances/ and ./bluespice/farm-archives/
   → You just need to rename the folders. No further changes within the folders are required.
3. There are no files ./bluespice/oauth_private.key and ./bluespice/oauth_public.key int the 4.5 directory.
   → They can be created, once the wiki-task container is running, using

bluespice-deploy exec wiki-task /app/bin/run-installation.d/040-create-oauth-keypair

Main database update

TBD

Special cases

Before running thedatabase 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

TBD

Extension:OpenIDConnect

ALTER TABLE openid_connect DROP COLUMN oidc_id;
ALTER TABLE openid_connect ADD PRIMARY KEY (oidc_user);

Duplicate keysIn case the 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.

HINT: FARM

Collabpads database update

TBD

SAML authentication

TBD

Updating from classic tarball installation

Since version 5.1 of BlueSpice, the only supported installation method is using bluespice-deploy . This section decribes how to move data from an existing 4.5 installation into this new setup. A freshly installed version of bluespice-deploy:5.1 is a prerequisite.

TBD