Software Upgrade/Downgrade, System Reset

MobileConnect Manager Upgrade and Redeploy

You can perform an update or redeploy of the Manager the same way the initial installation is done.

Warning

In case you have a firewall and you are updating from Manager version 1.0.0 or 1.1.0, you also need to make port 8383 accessible from the MobileConnect Station.

Warning

If you update your Manager from version 1.3.0 and lower to version 1.4.0 and higher, the QR codes and channel IDs will be regenerated and have to be redistributed to your users.

First, we recommend that you perform a backup of the Manager database before updating your Manager. See section MobileConnect Manager Database.

Next you should create a backup of the MobileConnect Manager authorization files:

  • If you have already authorized MobileConnect Stations you must also backup the folder “vernemq” in your Manager installation directory.

  • If you do not do this, you will have to remove and re-add all previously authorized Stations after the Manager redeploy process.

You are now ready to update your MobileConnect Manager. Enter your installation directory.

cd YOUR_MANAGER_INSTALLATION_DIR

Set your previously configured database password as local environment variable and stop the Manager.

export SA_PASSWORD='MyPass123'
docker-compose down

Warning

You need to run docker-compose down BEFORE copying new files into your installation directory. Otherwise, it could lead to outdated services staying active.

Warning

In case of “Invalid interpolation format” error after using the docker-compose command -> reinstall docker-compose following the instructions in “MobileConnect Manager docker-compose” in Manager Troubleshooting.

Open a browser and go to https://accounts.sennheiser-connect.com. Login with your credentials and download the latest installation package from the “Manager setup” page. Always download the latest Manager configuration files to make sure you have the latest version and configuration.

Copy the installation package to the installation directory and extract the archive. Overwrite the existing files when prompted.

Install and run with:

docker-compose pull
docker-compose up -d

Warning

If you’re upgrading from a version lower than 1.3.0 and encounter problems with your channel list, please see section “MobileConnect Manager upgrade” in Manager Troubleshooting

For more details, see section Step 3. Install the MobileConnect Manager.

MobileConnect Manager Database

The MobileConnect system uses a SQL Server 2019 database running in a Docker container. We recommend that you do a backup of your MobileConnect database regularly. Here is an example of how to do that.

Note

We use mcm_database as database name and mcmanager_sqldata as the name for the database volume. Please make sure to use the correct names for your implementation.

  1. Backup

# Set the path to where your backup should be created:
export PATH_FOR_BACKUP=~/backup

# If the backup-path does not exist, create it:
mkdir -p $PATH_FOR_BACKUP

# Copy the vernemq-folder to keep your authorizations:
cd YOUR_MANAGER_INSTALLATION_DIR
cp -r  vernemq/ $PATH_FOR_BACKUP

# Stop the current database:
docker stop mcm_database

# Create the backup:
docker run --rm --volumes-from mcm_database -v $PATH_FOR_BACKUP:/backup ubuntu tar cvf /backup/mcm_database.tar -C /var/opt/mssql .

Warning

  • Please run the previous command again if there is a message that tells you the following:

Unable to find image 'ubuntu:latest' locally
latest: Pulling from library/ubuntu
7b1a6ab2e44d: Pull complete
Digest: sha256:626ffe58f6e7566e00254b638eb7e0f3b11d4da9675088f4781a50ae288f3322
Status: Downloaded newer image for ubuntu:latest

# Check if the backup has been created (if everything ran successfully, you should see "mcm_database.tar"):
ls $PATH_FOR_BACKUP

# Start the database again:
docker start mcm_database

# Check the database volume name and note it down (needed for restoring):
docker volume ls | grep sqldata

  1. Restore

# Set the path to where your backup is located:
export PATH_FOR_BACKUP=~/backup

# Check the name of the volume that you noted down during the backup. In case your installation directory was named mcmanager, the volume name would be mcmanager_sqldata.
export DATABASE_VOLUME=mcmanager_sqldata

# Enter your installation directory:
cd YOUR_MANAGER_INSTALLATION_DIR

# Stop the current manager:
docker-compose down

# Copy the vernemq folder back into the working folder so your stations will still be authorized with the old database:
cp -r $PATH_FOR_BACKUP/vernemq/ YOUR_MANAGER_INSTALLATION_DIR

# Create a volume with the same name of your previous database volume:
docker volume create $DATABASE_VOLUME

# Restore the backup of your old database into the newly created volume:
docker run --rm -v $DATABASE_VOLUME:/recover -v $PATH_FOR_BACKUP:/backup ubuntu bash -c "cd /recover && tar xvf /backup/mcm_database.tar"

# Start the manager again (you need to be inside your installation directory):
docker-compose up -d

Stop and Remove the MobileConnect Manager

You can stop your MobileConnect Manager in the following way:

  • Navigate to the MobileConnect Manager installation directory.

  • Always set your database password before running docker-compose commands.

  • Run the command docker-compose down, which will stop the Manager containers and remove the related containers and networks.

cd YOUR_MANAGER_INSTALLATION_DIR
export SA_PASSWORD='MyPass123'
docker-compose down

You can do a more complete Manager system cleanup of all containers, images and volumes, created by the MobileConnect Manager installation. Simply run the three commands provided below.

docker container rm mcm_messagebroker mcm_database mcm_gateway mcm_registry mcm_configuration_api mcm_updater_api mcm_manager_web
docker image rm mcmanager.azurecr.io/configuration_api mcmanager.azurecr.io/updater_api mcmanager.azurecr.io/manager_web
docker volume rm mcmanager_sqldata mcmanager_vernemq

The above docker volume command is valid for installation directory “/home/$USER/mcmanager”. If your installation directory differs, check the list of volumes with the command below and remove the ones belonging to your installation.

docker volume ls

Alternative removal method is to remove all docker data with the docker prune commands. Only do this if you have no other docker applications.

docker container prune
docker image prune -a
docker volume prune

Finally, remove all Manager installation files by navigating out of the installation directory and removing it.

cd ..
sudo rm -rf YOUR_MANAGER_INSTALLATION_DIR

MobileConnect Station Update

The software upgrade and downgrade of a MobileConnect Station can be performed using the MobileConnect Manager.

  • Connect your MobileConnect Station to your MobileConnect network.

  • Open the MobileConnect Manager and go to Stations.

  • Select your device.

  • Click “Recheck firmware versions” to check for the latest firmware version.

  • Click “Start update”.

  • Select a version and click “Update now”.

    • In case of errors shown on the Manager during the firmware update which are not resolved over time, reboot the MobileConnect Station.

    • Since Station version 6.0.6, the reboot can be performed via the Manager.

Note

For upgrading a MCS v1 from software version 5.1.0 to higher, see section Upgrading a Legacy MobileConnect Station.

MobileConnect Station Reset

A software reset of the MobileConnect Station can be performed using the MobileConnect Manager.

  • Connect your MobileConnect Station.

  • Open the MobileConnect Manager and go to Stations.

  • Select your station.

  • Select “Reset device”.

    • This will fully reset the MobileConnect Station configuration and authentication to its defaults.

    • The Station will be removed from the Manager list of authorized devices and has to be authorized again. The reset can take up to 5 minutes.

    • After the reset is completed the Station is rebooted and enters the authorization state. You can now reauthorize the Station following the steps in Authorize a Station.