Note

Welcome to the SunFounder Raspberry Pi, Arduino & ESP32 Community on Facebook!

  • Get technical support and troubleshooting help.

  • Learn and share projects, tips, and tutorials.

  • Access early product previews and updates.

  • Enjoy exclusive discounts and giveaways.

👉 Join us here: [here]

Setting Up OpenMediaVault

Warning

OpenMediaVault does not support installation on the Raspberry Pi OS desktop.

⚠️ Only Raspberry Pi OS Lite versions 11 (Bullseye) and 12 (Bookworm) are supported.

Please make sure you have installed the correct operating system and configured the network. The procedure here is consistent with Installing the Operating System, but when selecting an image, please choose Raspberry Pi OS Lite from Raspberry Pi OS (other).

../../_images/omv-install-12.png

OpenMediaVault (abbreviated as OMV) is an open-source Network Attached Storage (NAS) operating system based on Debian Linux, designed for home users and small office environments, aiming to simplify storage management and provide rich network service features.

Please follow these steps to install OpenMediaVault on your Raspberry Pi:

1. Connect to Your Raspberry Pi Using SSH

Enter the following command in the terminal:

ssh pi@raspberrypi.local

If you are using Windows, use PuTTY or another SSH client to connect to your Raspberry Pi.

2. Install OpenMediaVault

Enter the following command in the terminal:

wget https://github.com/OpenMediaVault-Plugin-Developers/installScript/raw/master/install
chmod +x install
sudo ./install -n

This will download and run the installation script for OpenMediaVault. Do not restart your Raspberry Pi after installation.

3. Access OpenMediaVault

Enter the following URL in your browser to access OpenMediaVault:

http://raspberrypi.local

Note

If you cannot access the above URL, try using the IP address instead, for example, http://192.168.1.100.

You will see a login page, log in using the default username and password. The default username is admin, and the password is openmediavault.

../../_images/omv-login2.png

After logging in, you will see the main interface of OpenMediaVault.

../../_images/omv-main2.png

Now that you have successfully installed and accessed OpenMediaVault, you can start configuring and managing your storage.

4. Set Up RAID (Optional)

NVMe RAID is a storage solution that combines multiple NVMe Solid State Drives (SSDs) using RAID technology, aimed at maximizing the high-speed performance of the NVMe protocol and the redundancy/performance enhancement features of RAID. Common modes include RAID 0, 1, 5, 10, etc. For dual NVMe SSDs, RAID 0 and RAID 1 are the most commonly used modes.

  • RAID 0 is a striping technology that divides data into multiple stripes and distributes these stripes across multiple hard drives, thus achieving higher read/write speeds. RAID 0 does not provide redundancy protection, so if any one of the hard drives fails, all data will be lost.

  • RAID 1 is a mirroring technology that copies data across multiple hard drives, thus providing redundancy protection. The read/write speeds of RAID 1 depend on the speed of a single hard drive, as data needs to be read from multiple hard drives. If any one of the hard drives fails, the others can continue to provide data.

Note

At least mount 2 disks for RAID 0 or RAID 1. In RAID 0, the capacity of the RAID volume will be the sum of the capacities of all disks. In RAID 1,the capacity of the RAID volume will be the same as the capacity of the smallest disk.

  1. In the System menu click on the Plugins option, search for the openmediavault-md plugin, and install it.

../../_images/omv-raid-12.png

  1. In the Storage menu click on the Disks option, erase two SSDs.

../../_images/omv-raid-22.png

  1. Please note that this action will erase all data on the hard drives, make sure you have backed up all important data.

../../_images/omv-raid-32.png

  1. Erase mode select QUICK is sufficient.

../../_images/omv-raid-42.png

  1. Enter the Multiple Device tab, click Create.

../../_images/omv-raid-52.png

  1. In the Level option, you can choose Stripe (RAID 0) or Mirror (RAID 1). In the Devices option, select the hard drives you just erased. Click Save and wait for the RAID configuration to complete.

../../_images/omv-raid-62.png

Note

If an error report (500 - Internal Server Error) pops up, try restarting the OMV system.

  1. Apply the configuration by clicking on the Apply button.

../../_images/omv-raid-72.png

  1. After the RAID configuration is complete, you have to wait the state of the RAID to be 100%.

../../_images/omv-raid-82.png

  1. After the RAID configuration is complete, your hard drives are now in a RAID 0 or RAID 1 configuration, and you can use them as a single storage device.

5. Configure Storage

In the main interface of OpenMediaVault, click on the Storage option in the left-side menu. In the Storage page, click on the Disks tab. On the Disks page, you will see all the disks on your Raspberry Pi. Ensure your NVMe PIP has a connected hard drive.

../../_images/omv-disk2.png

  1. In the sidebar, click the File System option. Then create and mount a file system. Choose ext4 as the file system type.

../../_images/omv-mount2.png

  1. Select Device, and save.

Note

If you have set up the RAID, you will see the RAID device in the list. Just select it and save.

../../_images/omv-mount-22.png

  1. A window will appear, informing you that the file system is being created, please wait a moment.

../../_images/omv-mount-32.png

  1. Once done, you will enter the Mount interface, select the file system you just created, and mount it to your Raspberry Pi.

../../_images/omv-mount-42.png

Note

If you are using dual hard drives (and not RAID), you should repeat the above steps to also mount the second hard drive to your Raspberry Pi.

  1. After mounting, please Apply, and then you can see the data on your hard drives in the file system.

../../_images/omv-mount-52.png

At this point, you have successfully configured OpenMediaVault and mounted your hard drives. You can now use OpenMediaVault to manage your storage.

6. Create a Shared Folder

  1. In the Storage page, go to the Shared Folders tab. And click the Create button.

../../_images/omv-share-12.png

  1. In the Create Shared Folder page, enter the name of the shared folder, select the hard drive you want to share, the path of the shared folder, and set the permissions of the shared folder. Then click the Save button.

../../_images/omv-share-22.png

  1. Now you can see the shared folder you just created. Confirm it is correct, then apply.

../../_images/omv-share-32.png

You have now successfully created a shared folder.

7. Create a New User

To access the folder, we need to create a new user, please follow these steps:

  1. In the User page, click the Create button.

../../_images/omv-user-12.png

  1. In the Create User page, enter the new user’s username and password, then click the Save button.

../../_images/omv-user-22.png

You have now successfully created a new user.

8. Set Permissions for the New User

  1. In the Shared Folders page, click on the shared folder you just created. Then click the Permissions button.

../../_images/omv-user-32.png

  1. In the Permissions page, set the permissions. Then click the Save button.

../../_images/omv-user-42.png

  1. After completing, click the Apply button.

../../_images/omv-user-52.png

You can now use this new user to access your shared folder.

9. Configure the SMB Service

  1. In the Services page, find the SMB/CIFS > Setting tab. And check the Enable option. Then click the Save button.

../../_images/omv-smb-12.png

  1. Apply the changes by clicking the Apply button.

../../_images/omv-smb-22.png

  1. Enter the Shares page, click the Create button.

../../_images/omv-smb-32.png

  1. In the Create Share page, select the path of the shared folder. Then click the Save button. Incidentally, there are many options on this page that you can configure as needed.

../../_images/omv-smb-42.png

  1. Click Apply.

../../_images/omv-smb-52.png

You have now successfully configured the SMB service. You can now use the SMB protocol to access your shared folder.

10. Access the Shared Folder on Windows

  1. Open This PC, then click Map network drive.

../../_images/omv-network-location-12.png

  1. In the pop-up dialog box, enter the IP of the Raspberry Pi in the Folder field, for example, \\192.168.1.100\, or the Raspberry Pi’s hostname, for example, \\pi.local\.

../../_images/omv-network-location-22.png

  1. Click the browse button, then select the shared folder you want to access. During this process, you will need to enter the username and password you created earlier.

../../_images/omv-network-location-32.png

  1. Check “Reconnect at sign-in”, and click the Finish button.

../../_images/omv-network-location-42.png

  1. You can now access the NAS shared folder.

../../_images/omv-network-location-52.png

10. Access the Shared Folder on Mac

  1. In the Go menu, click Connect to Server.

../../_images/omv-mac-12.png

  1. In the pop-up dialog box, enter the IP of the Raspberry Pi, such as smb://192.168.1.100, or the Raspberry Pi’s hostname, such as smb://pi.local.

../../_images/omv-mac-22.png

  1. Click the Connect button.

../../_images/omv-mac-32.png

  1. In the pop-up dialog box, enter the username and password you created earlier. Click the Connect button.

../../_images/omv-mac-42.png

  1. You can now access the NAS shared folder.

../../_images/omv-mac-52.png