As of 30th June 2022 Openmediavault 5 has now gone end of life. . In order to continue using Openmediavault (OMV) and get all the latest security updates, you will need to update your OMV 5 installation to the new stable OMV 6. This is episode 32 in our Raspberry Pi series.
Table of Contents
In this guide, we will give an overview of what you will need to do in order to upgrade Openmediavault 5 to 6 on your Raspberry Pi 4.
If you would like to be taken step by step through the process in fine detail then please watch our YouTube Episode above. In this episode, we will show you the complete upgrading process from the very beginning to having a fully migrated working system.
In order to follow along with this guide/episode 32 you will need to have the following prerequisites:
- A Raspberry Pi 4 device with existing installation connected to the network.
- A Micro SD Card and a means to connect it to your computer (Micro SD To USB Adapter).
- Existing Openmediavault 5 installation.
- Docker and Portainer Installed.
- Existing data (AppData, Docker containers, Shares, etc).
- A device to initiate an SSH terminal session.
- Internet access to download software.
- Any attached USB storage devices UUID’s.
The Upgrade Process:
The Operating System:
If you have followed along with our Raspberry Pi series your current install may be running an older version. The older version is Raspberry Pi OS Lite (Legacy) based on Debian 10 (Buster). You will know if you are on the older OS as you will be running Openmediavault 5.
Unfortunately, the only way to upgrade the OS and OMV5 to the latest version (which is Raspberry Pi OS Lite based on Debian 11 (Bullseye) is to start afresh with a clean install
However, all is not lost as you can manually upgrade the OS and OMV. In this article, we will explain how you can achieve this.
in order to upgrade Openmediavault 5 to Openmediavault 6. You will need to be on Raspberry Pi Lite (Bullseye) based on Debian 11. This will require a clean installation.
Things you need to do before Upgrading to Openmediavault 6:
Backup your existing data:
Before starting the upgrade process you will need to backup some important information. This will help you to migrate that data more easily later on to OMV6. Below is a list of data that you will need to back up manually. You can do this using notepad or your text editor of choice. Make sure to save the data on a separate device or storage medium.
Not all this information is needed however it can be very useful as a reference to help you set things up much quicker when you are restoring all your data later on.
Take a note of all your OMV 5 dashboard settings.
Go through your OMV 5 dashboard and take notes of your settings. Go from the very top of the left-hand menu and work your way down to the bottom. The main things you need to take note of are:
- System > General Settings – Take a note of the ports your OMV dashboard is using.
- System > Notifications – Take a note of any SMTP settings if you use that feature.
- System > Plugins – Take note of any plugins you have installed
- System > OMV-Extras > Docker – Take note of where your Docker Storage is located.
- Storage > File Systems – Take a screenshot or note of all device/s information data.
- Access Rights Manager > User – Take a screenshot or note of all user accounts and their group permissions.
- Access Rights Manager > Shared Folders – Take a screenshot of all shares and relative paths.
Take a note of all storage device names and folder ID’s.
Take a note of all device names and partitions. You can use the lsblk command. This command will also show you the mountpoints.
Next, navigate to the /srv/ folder by using the ls command.
Take a note of all external storage devices UUID’s and their mountpoint names under /srv/ folder.
Backup Your Docker containers compose files (Stacks)
Go to your Portainer dashboard and navigate to Stacks.
From within here, you will need to make a copy of all your stack docker-compose files.
You can copy each stack manually to a notepad or text editor of your choice.
Optional – backup the Portainer compose folder
You can also backup the Portainer data compose folder which contains your docker-compose files. This is completely optional.
These folders are oddly labeled with numbers so you will have to take note of which numbers point to which container. You can find the referenced number in the container details in Portainer’s Dashboard.
Portainer stores its data in a mounted folder (/data) this can be located in a different location depending on your installation. So you will need to confirm the absolute path of the /data folder. You can do this by clicking on the portainer container > Host/volume section > click on portainer_data details page under Volume details make note of the Mount path location.
Knowing the location of the above absolute portainer /data mount path. The docker-compose.yml data files will be in the nested inside the compose folder – /var/lib/docker/volumes/portainer_data/_data/compose
Use the below command to navigate into it:
You will need to back this compose folder up to an external storage medium using the cp command.
Example (you will need to customize this command to suit your installation):
cp -r /var/lib/docker/volumes/portainer_data/_data/compose /srv/dev-disk-by-uuid-ID/backup-folder
Backup any none persistent data stored on the root partition.
Make sure that no docker container’s persistent data has been saved to the root drive where your operating system resides. When you go to write a fresh operating system (OS) image all data stored on your root drive will be lost.
You will also need to backup any user folders in your /home directory as this folder is located on the root partition and all data will also be lost on the reinstallation of the OS.
If you have followed along with our Raspberry Pi Series and installed NGINX Proxy Manager. The NGINX persistent data folder is located in the /home directory. Take a backup of this folder or you will not be able to restore your NGINX Proxy Manager container.
Back up any custom scripts, crons or scheduled tasks.
If you have any custom scripts, crons, or scheduled tasks. You will want to take note of these commands and script files so you can restore them on your clean OMV 6 installation. Copy them to a safe place.
Backup Your Docker Data.
It is good practice to always have a backup of your AppData folder. The name of this folder can vary but in essence, it is where you have stored all your docker container’s persistent data. In our Raspberry Pi Series, I have stored these in a folder called AppData.
To be safe backup your AppData folder to an external drive or source. This is just in case something goes wrong when restoring the Docker containers on your new installation you will always have a backup of the original files.
At the very least, make sure you disconnect any external drives with persistent data while you reinstall and configure the new OS.
Troubleshooting Docker data locations
If you are having any problems finding your docker data locations you can use the docker ps command.
From a terminal run:
You can get detailed information using the docker name and the docker inspect command. This includes mount paths and folder bind locations.
Run the following command replacing radarr with the name of your container.
docker inspect radarr
Now you have all your settings and data backed up safely it is time to Install Raspberry Pi OS lite to your Raspberry Pi 4.
Installing the latest Raspberry Pi OS Lite
Install Raspberry Pi OS on An SD Card.
Please follow our post below to install Raspberry Pi OS on an SD card. Then come back to this guide when you are finished.
Optional – Install Raspberry Pi OS on SSD or Flash Drive.
Once you have completed installing Raspberry Pi OS to an SD card you can optionally move that installation across to an SSD or a flash drive.
Follow the guide below if this is something you would like to do.
Please return to this guide once you have finished.
Updating your Raspberry Pi OS lite
Now you have Raspberry Pi OS lite installed. You will need to update your Raspberry Pi OS lite with all the latest security patches and software.
Run the following in the terminal:
sudo apt update -y && sudo apt upgrade -y
You are now ready to install Openmediavault 6 on to your Raspberry P 4.
Please follow our guide below.
Install Openmediavault 6 on your Raspberry Pi
Now you have completed the installation of your new server. It is time to restore all your settings and data from your old server.
Restoring your Openmediavault 5 data
Navigate to the OMV 6 dashboard by going to your Raspberry Pi IP address in your chosen browser.
You should now see the OMV 6 login splash screen.
Once at the login splash screen enter the default username and password which is:
Now you are logged into the Dashboard you can begin to restore your OMV settings.
Restore your Openmediavault Settings
You will want to restore all the information we backed up earlier. Go through each menu and set the settings the same as were set in your OMV 5 installation. Once you have completed all the settings you can move on to the next step.
- Move your OM6 dashboard to the correct port locations and create an SSL for your dashboard so you can connect securely.
- Set the correct Date and Time.
- Set up Email Notification SMTP settings. (Optional)
- Edit your Network configuration and add a Static IP address for your Raspberry Pi. This will make sure that you can always connect to your Raspberry Pi through its IP address and it won’t change to something else.
Warning! Only change the Network configuration if you understand what you are doing. You can break your network stack. If you are unsure skip this step.
Restore all your User accounts and add them to the correct groups.
If you had any custom user accounts you will need to create a new user account either through the terminal (which will create a home/user directory). Or you can create the user through the Users menu.
Make sure you add any custom user accounts to the correct groups. You will want to match your previous OMV 5 user/group setup.
Normally these groups are:
adm, sambashare, ssh, sudo, user1, users
Optional: When you have installed Docker come back into the Users menu and add the custom user to the docker group.
Mount all your existing drives & restore your shares.
As we are migrating existing data from a previous OMV installation. In order to read the drive/s filesystem/s which holds the data, You will need to mount them to the new OMV 6 server using the Mount option.
Connect all your USB storage devices to the Raspberry Pi and make sure they are powered on.
Under Storage > File Systems you will want to click the blue + icon from the menu then select the mount option to mount your drive/s existing file system/s. Do this for each of your drives or partitions.
Important do not use the create option here as it will wipe all your data from your external storage devices.
Restore all your shares and mount them to the correct Relative paths in the drop-down list.
Under Services > SMB/CIFS > Settings Enable SMB
Under Services > SMB/CIFS > Shares restore all your shares and set the correct permissions.
Under omv-extras > Docker click “Install” to install Docker.
Under omv-extras > Portainer click “install” to install Portainer.
Restore Docker Containers
Before restoring any containers. Make sure you have checked that your user has the same UID and GID.
Also, check that your drive file paths are the same as what is stated in your docker-compose files. once you have confirmed this you are ready to restore your stacks.
Now that Portainer is installed you can navigate to the dashboard:
Now go to Stacks.
Locate where you stored all your docker-compose.yml files or stack outputs you took earlier in the backup section.
You will want to create a new stack for each application and paste the stack/docker-compose data from your backup file/s into the stack’s web editor. Once you have confirmed that all the details are correct and valid. You can click on deploy the stack.
Once the container has finished deploying. Check that everything is ok by connecting to the container’s application and check that all your data has been restored.
You will want to do this for each container you restore.
Finish setting up the dashboard
Make any final tweaks to the dashboard. Set up the dashboard page with widgets. Make it look great.
You may also want to change the default port for SSH. This can be done under Services > SSH.
Openmediavault 6 graphically has really improved since its previous major version. It looks much cleaner and I really like the Dashboard and how it displays the server’s statistics. It works in pretty much the same way and any changes under the hood are not very obvious. It seems to be very stable and I didn’t run into any problems when installing or restoring my existing data.
Well done to Openmediavault for a great new version.
This concludes today’s guide. if you would like a more detailed upgrade guide with step-by-step instructions. Then please watch our accompanying YouTube episode tutorial.
In the YouTube episode we also show you how to:
- Restore NGINX Proxy Manager
- Repair NZBGET
- Fix Wireguard not connecting
- Plus much more.
We Need Your Support
Did you get any benefit out of this guide or YouTube Tutorial?.
If you did, please consider supporting our channel by Subscribing to our YouTube channel, and liking and sharing our content.
Please ask if you have any questions or requests in the comments below or on YouTube.