omv7:raspberry_pi_install [omv-extras.org]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
{{indexmenu_n>2}}

<html><!---
Remark: Given the similar setup, this doc contains numerous reused screen shots from the OMV6-Raspberry PI doc.
---></html>

<html><center><span style="color:#000066;font-size:300%;">Installing OMV7 on a Raspberry PI</span></center></html>

\\ 
\\
{{ :omv7ug_-_top.jpg?600 |}}
\\
====== Installing OMV7 on a Raspberry PI ======
\\ 
Revisions:\\
February, 3rd, 2024 - Short version for RC1\\
February, 11th, 2024 - Expanded / Full version.\\ 


===== Introduction =====

Installing OMV7 on Raspberry PI OS Lite, using a scripted install, is a relatively easy task.  This document is a guide for that process. 

\\ 


  
===== About this Guide =====

The purpose and intent of this guide is to provide a walk-through to get Raspberry Pi users (hereafter referred to as an “**R-PI**”) up and running as quickly and as easily as possible.  This guide assumes that users have a working Windows Client for installing and executing the needed utilities.  It is also assumed that Mac and Linux desktop users will be able to find, install, and use utilities equivalent to those called out in Prerequisites.

  * This is a community document and a work in progress.  Input and feedback are welcome and can be sent to: [[omvguide@gmail.com]]

\\ 
===== Supported Devices =====

OMV7 will install on R-PI models 2B and higher.  However, in practical terms, the performance of the model 2B is marginal.\\ 

\\ 
===== Not Supported =====

  * **__Desktop__** versions of Raspberry PI OS are **NOT** supported.  (Use the __Raspberry PI OS "**lite**"__ version only.)

  * //**Legacy Raspberry PI's**//
R-PI models **earlier** than the 2B and the R-PI Zero have not been tested and are not supported.  They are far too slow to run a NAS application.  
Please do not post on [[https://forum.openmediavault.org/|OMV's forum]], expecting support for these models.

\\ 


===== Prerequisites =====


This installation process __requires__ a wired Ethernet connection and Internet access.
Typically, all that is needed to begin the installation is an Ethernet cable, a power supply sufficient for the R-PI model being used, and one SD-card (two SD-cards are preferred for backup).

To get started, a few utilities are needed to check the SD-card and install the Raspberry PI OS image.

  * Raspberry PI OS images are installed using the Raspberry PI OS imager.  Download the appropriate imager -> [[https://www.raspberrypi.com/software/|here]]. (Imager downloads are at the bottom of the page.)  The Raspberry PI OS imager is installable on a Windows client.
  * [[https://www.sdcard.org/downloads/formatter/index.html|SDformatter]] is a utility for formatting SD-cards that does a trim operation on flash media to clear remnants of old deleted files. SDformatter is installable on a Windows client.
  * Users will need a utility like [[https://www.7-zip.org/|7-Zip]] to decompress zip archives like the SD-card test program below.  7-Zip is installable on a Windows client.   
  * [[http://www.heise.de/ct/Redaktion/bo/downloads/h2testw_1.4.zip|h2testw_1.4]] is a flash media test program.  With a freshly formatted SD-card or USB thumbdrive, it writes files with known content and verifies the content in a read operation, detecting errors in the process.  **h2testw_1.4** downloads as a zip file.  By right clicking on the zip file and using “Extract All”, 7-Zip will expand the zip file to a folder named **h2testw_1.4**  The executable inside this folder is a portable application. Run the executable. 
  * [[https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html|PuTTY]] is an SSH client that will allow users to connect to their SBC, from a Windows client, and get on the command line.  PuTTY is installable on a Windows client. 
  * While 8GB is the minimum and will work fine, a 16GB SD-card will provide longer life in the role of a boot drive.  Users are encouraged to get two SD-cards.  One is for the installation and a second card for backing up the OS installation, when configuration is complete.  


For the best experience, use only high quality **__new__** SD-cards, such as Samsung or SanDisk, that are rated A1 Class 10 or better.

{{ :armbian1_sd-card.jpg?80 |}}
{{ :divider2.png?800 |}}

==== Format and Test Flash Media ====

Due to the rise in counterfeit media and media that reports a fake size, it’s recommended that all SD-cards or USB thumbdrives, new or used, be formatted with SDFormatter and tested with h2testw1.4 before using them.

<html>
<body>
  <table width="100%" border="0">
    <tr>
      <td colspan="2" style="background-color:#69A5FF;height:30px;">
        <strong><span style="color:#FFFFFF;font-size:110%;">&#160; Note</span></strong>
      </td>
    </tr>
    <tr>
      <td style="background-color:#E6FEFF;height:25px;width:380px;">
        When an SD-card is inserted and recognized, Windows may offer to format the card several times.  Cancel <b>all</b> of these attempts. 
    </tr>
  </table>
</body>
</html>
----
\\
<html><center>Using <b>SDFormatter</b>, do a clean <b>Format</b>:</center></html>
\\

<html><center>In most cases, SDFormatter will detect the SD-card or thumb-drive.  A volume label is not necessary, at this point, and the default options are fine.</center></html>


{{ ::omv6-rpi-4.jpg?400 |}}
\\

<html><center>Note that SDFormatter does a "<b>trim</b>" operation on the card which cleans up remnants of previously existing or deleted files.</center></html>  


{{ :divider2.png?600 |}}

<html><center>After the SD-card format is completed, open <strong>h2testw</strong> and select your language.</center></html>
<html><center>Then, click on <strong>Select target.</strong></center></html>


{{ ::omv6-rpi-5.jpg?400 |}}

{{ :divider2.png?600 |}}

<html><center>Under <strong>Computer</strong>, select the flash media previously formatted.</center></html>

{{ ::omv6-rpi-6.jpg?400 |}}

{{ :divider2.png?600 |}}
 
<html><center><strong>Select Write+Verify</strong>.  (<strong>Do not</strong> check the <b>endless verify</b> box).</center></html>

{{ ::omv6-rpi-7.jpg?400 |}}

{{ :divider2.png?600 |}}

<html><center>A dialog similar to the following may pop up, mentioning a 1MB difference.  Ignore it and click on <strong>OK</strong>.</center></html>

{{ ::armbian10_h2testw_warning.jpg?400 |}}

{{ :divider2.png?600 |}}

<html><center>“<strong>Without errors</strong>” is the desired outcome.</center></html>  
<html><center>If the media tests with errors or is much smaller than is indicated by the SD-card's labeled size, don't use it.</center></html>

{{ ::omv6-rpi-8.jpg?400 |}}
\\
\\
<html><center>After H2testw verifies the SD-card; <b>do one more clean format</b>, using SDFormatter, before flashing the card.</center></html>  
 
{{ :divider2.png?600 |}}


===== Burning the Image =====
\\ 

==== Preinstallation Notes ====

All supported models of Raspberry PI will run the 32bit lite image of Raspberry PI OS.  However, when using the 32bit image, model 4's with 8Gb of ram would be limited to using 4Gb of ram for a "single process".  This is not to say that the extra 4Gb of ram is wasted.  The additional 4Gb would be distributed among additional processes.  However, the 64bit lite version will allow more than 4Gb per process and, in many instances, performance is better / faster.\\
\\
In any case, users with Raspberry PI **models 3 or higher** will be well served with **64bit lite** version.\\
Users of Raspberry PI **model 2B** users should use the **32bit lite** image.\\
----
==== The Raspberry PI OS Imager ====
 
The Raspberry PI Imager is a convenient "all in one" utility for burning Raspberry PI OS onto an SD-card.  In the options allowed by the imager, the appropriate image for OMV is selected, the image is downloaded, it's burnt to the SC-card and the image is verified in one step.
----

<html><center>As previously noted, the imager installs as a standard Windows program.</center></html> 
\\
{{ :OMV7-RPI-imager-1.8.4.jpg? |}}

----

\\
<html><center>Under <b>Rapsberry PI Device</b>, click  <b>"Choose Device".</b></center></html>
<html><center>From the pop down list, select the applicable device.</center></html>

{{ ::omv7-rpi-imager-2.jpg? |}}

<html><center>In this instance, an R-PI4 was selected.</center></html>
<html><center>As a reminder; <b>R-PI's 5, 4, 3,</b> and <b>2B</b> are supported. Other variants are <b>NOT</b> supported.</center></html>
\\
\\
----

<html><center>Under <b>Operating System</b>, click  <b>CHOOSE OS</b>.</center></html>
<html><center>From the pop down menu, click <b>Raspberry PI OS <u>(other)</u></b>.</center></html>
\\
<html><center>• Users of <b>Raspberry PI models 3 and higher</b> should select <b>Raspberry PI OS Lite (64bit)</b></center></html>
<html><center>• <b>Raspberry PI model 2B</b> users should scroll down and select <b>Raspberry PI OS Lite (32bit)</b>.</center></html>

{{ ::omv7-rpi-imager-3.jpg? |}}
\\
<html>
<body>
  <table width="100%" border="0">
    <tr>
      <td colspan="2" style="background-color:#FFB663;height:30px;">
        <strong><span style="color:#FFFFFF;font-size:110%;">&#160; Warning </span></strong>
      </td>
    </tr>
    <tr>
      <td style="background-color:#FFE4A6;height:25px;width:380px;">
        <b>Do not select "Full" versions of Raspberry PI OS.</b>  Desktop versions are <b>not compatible</b> with Openmediavault. 
    </tr>
  </table>
</body>
</html>
\\
----

\\
<html><center>Under <b>Storage</b>, click  <b>Choose Storage</b>.</center></html>
<html><center>(Typically an SD-card will be recognized, by the imager, automatically.)</center></html>
<html><center>Click on the SD-card line to select it.</center></html>

{{ ::omv7-rpi-imager-4.jpg? |}}

----
\\

<html><center>Click  the <b>NEXT</b> button</center></html>
<html><center>A dialog box pops up; <b>Would you like to apply custom OS settings?</b></center></html>
<html><center>Click ; <b>Edit Settings</b></center></html>
\\

  * Check the box for **Set Hostname**:  User's choice - the default is fine.
  * Check the box for **Set username and password**:  These entries will create an admin user with **SUDO** capabilities.
  * **DO NOT** check the box for **Configure Wireless Networking**:  Configuring WiFi will be done later, in OMV's GUI.
  * Check the box for **Set local settings**:  Set for the user's time zone.
\\
{{ ::omv7-rpi-imager-5.jpg? |}}
\\
<html>
<body>
  <table width="100%" border="0">
    <tr>
      <td colspan="2" style="background-color:#FFB663;height:30px;">
        <strong><span style="color:#FFFFFF;font-size:110%;">&#160; Warning </span></strong>
      </td>
    </tr>
    <tr>
      <td style="background-color:#FFE4A6;height:25px;width:380px;">
        The username, created in this dialog, <b>CAN NOT</b> be <b>admin</b>.  <b>admin</b> is reserved for the OMV installation. 
    </tr>
  </table>
</body>
</html>

\\
<html><center>At this point, <b>Do Not</b> click Save.</center></html>
\\
----
<html><center>Click on the <b>Services</b> Tab.</center></html>
<html><center>Check the box for <b>Enable SSH</b></center></html>
<html><center>This selection will automatically set "Use Password Authentication".</center></html>

{{ ::omv7-rpi-imager-6.jpg |}}

<html><center>Click <b>Save</b>.</center></html>
\\
----

<html><center>At this point the <b>Use OS customization</b> dialog box reappears.</center></html>

{{ ::omv7-rpi-imager-7.jpg? |}}
 
<html><center>Click <b>Yes</b>.</center></html>

----
<html><center>A <b>Warning</b> dialog box reappears.</center></html>

{{ ::omv7-rpi-imager-8.jpg? |}}

<html><center>Click <b>Yes</b>.</center></html>

<html><center>Again, <b>Windows may prompt to format the SD-card</b> at the beginning and at the end of the flashing operation.</center></html>
<html><center><b>Cancel</b> all of <b>these attempts</b>.</center></html>
----
<html><center>The Raspberry PI imager will write and verify the SD-card.</center></html>
<html><center>When the imager prompts to remove the SD-card, install it into the R-PI.</center></html>
<html><center></center></html>

{{ :divider2.png?600 |}}
===== The First Boot =====

*At this point, a wired Ethernet connection is **required** to connect to the R-PI, with PuTTY, and to install OMV in a later process.*

  * Insure the R-PI is connect to wired Ethernet.  
  * Insert the SD-card with the Raspberry PI OS image into the R-PI and apply power. 
  * Wait 3 to 5 minutes. 

The IP address to use for logging into the console is available from your DHCP server.  In most cases, your DHCP server will be running on your LAN's router.  Log into your router and look for the IP address associated with your R-PI.

\\ 

<html><center>The following is a DHCP server example.</center></html>
<html><center>(In this example, the hostname "Raspberry PI" was changed to "R-PI4".)</center></html>

{{ ::omv7-rpi-1srt_boot-1.jpg?800 |}}

\\
<html><center>With the IP address noted, proceed to <b>First Time Login</b>.</center></html>

{{ :divider2.png?600 |  |}}

<html><center><strong>If there's a problem with obtaining a DHCP assigned IP address:</strong></center></html>

  * In the event that an IP address is not issued to your SBC, check the wired Ethernet connection and reboot the device.  This may mean unplugging and plugging the power supply back in.  Allow time for boot up (5 minutes or so) and check the DHCP server again.
  * If an address is not issued, or if the user doesn't know how to find the Raspberry Pi's IP address on their DHCP server, connect a monitor and a USB keyboard to watch the boot process until it completes.  If the IP address is not displayed at the end of the boot cycle, login with the user **pi** using the password **raspberry**.
  * In rare instances, it may be necessary to reboot the LAN's router, followed by rebooting the Raspberry PI.

Once logged in, type ''ip add'' on the command line.  Note the IP address of the Ethernet interface, in the output, and proceed to **First Time Login**.

To be able to utilize Copy + Paste:
Working with the R-PI using SSH, as detailed in **First Time Login**, is highly recommended.

{{ :divider2.png?600 |}}

===== Raspberry PI OS - First Time Logon =====


<html><center>Open <b>PuTTY</b> and type in the <b>IP address</b> as previously found.</center></html>
<html><center>(Optional, but recommended: Give the session a name, under <b>Saved Sessions</b> and save it for future use.)</center></html>
<html><center>Click on <b>Open</b> to start the session.</center></html>

{{ ::omv7-rpi-1srt_boot-2.jpg? |}}

\\
<html><center>A PuTTY <b>Security Alert</b> will pop up in a first time connection.</center></html>  
<html><center>This is normal.  Ignore it and select <strong>Yes</strong>.</center></html> 

{{ :divider2.png?600 |}}

<html><center><strong>When the SSH window opens:</strong></center></html>  
<html><center>Login with the username and password entered in the R-PI imager.</center></html>

{{ ::omv7-rpi-1srt_boot-3.jpg? |}}

----
 
\\


===== Raspberry PI OS Updates and Upgrades =====

Before installing OMV, update, upgrade and prepare Raspberry PI OS using the following commands, executed one at at time:

''sudo apt-get update''  

''sudo apt-get upgrade -y ''

''wget -O - https://github.com/OpenMediaVault-Plugin-Developers/installScript/raw/master/preinstall | sudo bash''


\\
When the above commands are complete, type;  

''sudo reboot'' \\
\\
PuTTY will disconnect – this is expected.  Wait 3 to 5 minutes and reopen a new PuTTY SSH window and log in again. \\
\\
<html>
<body>
  <table width="100%" border="0">
    <tr>
      <td colspan="2" style="background-color:#69A5FF;height:30px;">
        <strong><span style="color:#FFFFFF;font-size:110%;">&#160; Note</span></strong>
      </td>
    </tr>
    <tr>
      <td style="background-color:#E6FEFF;height:25px;width:380px;">
        <p>In the event that the SSH client does not respond to the IP address used during the first boot, look at your DHCP server to see if a “new” IP address has been assigned.</p>
        In rare cases, the LAN's router / DHCP server may need a reboot.
    </tr>
  </table>
</body>
</html> 

\\ 

  
===== Install OMV =====


Installing OMV on Raspberry's is very easy, thanks to Arron Murray (ryecoaaron on the [[https://forum.openmediavault.org/|OMV Forum]]) for providing a comprehensive installation script that's executed from a single line. 

Copy the following line complete (**Ctrl+C**) and paste it into PuTTY's SSH window, with a right mouse click.  Then hit **Enter**.

''wget -O - https://github.com/OpenMediaVault-Plugin-Developers/installScript/raw/master/install | sudo bash''


Once the script is running, click out of the SSH window so the script will not be interrupted. \\
**Do Not close PuTTY** – that will terminate the root session.  Minimizing PuTTY is OK, but it must be running. 
     
Depending on several factors, running this script may take up to 30 minutes.

When the script is complete, the R-PI will automatically reboot.

\\ 
  
==== First Time GUI Logon ====

After 3 to 5 minutes, OMV can be logged in using the same IP address that was used for the SSH client, entered in a web browser address bar.   The web GUI user is **admin** and the default password is **openmediavault**

\\ 
**Note** - after the completion of the script:

In the event that the OMV console or SSH client does not respond to the IP address used 
during the installation, recheck  your DHCP server to see if a “new” IP address has been assigned.

(Typically, consumer router DHCP leases last at least 24 hours.  In cases where DHCP leases are 
very short - as it is with some versions of DD-WRT router firmware [10 minutes] - the lease issued 
to the SBC may time out at the end of the installation.  A different address may be issued on reboot.)

\\ 


  
===== Finishing Up =====


  * **To add an existing or add-on Wireless Interface** to openmediavault, see [[https://wiki.omv-extras.org/doku.php?id=omv6:raspberry_pi_install#final_notes|Final Notes]] below.
  * New users can continue with the setup of OMV using the [[https://wiki.omv-extras.org/doku.php?id=omv7:new_user_guide|Getting Started with Openmediavault 7]] guide, starting in the section titled → [[https://wiki.omv-extras.org/doku.php?id=omv7:new_user_guide#initial_configuration|Initial Configuration]].
  * All users are encouraged to review this resource → [[https://wiki.omv-extras.org/doku.php?id=omv7:utilities_maint_backup|Utilities, Maintenance & Backup]] for an easy process to clone your SBC's SD-Card and for additional information that will help in managing and maintaining an openmediavault server.




\\ 

===== Final Notes: =====



==== Wireless Networking ====

First it should be noted that using a wireless interface, with a server, is not the best idea.  To prevent a number of issues such as interference, bandwidth contention issues with clients, etc., a server should be connected to the **wired** LAN ports of a router or a network switch.  However it is understood that, in some cases, wired connections may not be an option.

If your R-PI is equipped with a wireless interface, by default, OMV will not show it in the GUI but it can be added. 
  * An existing interface can be added as noted in the following.
  * After plugging it in, a compatible add-on USB wireless interface can be added in the same manner.
\\


<html><center>Under <b>Network</b>, in the <b>Interfaces</b> tab, click on the <b>+ Add</b> button.  From the pop up, select <b>Wi-Fi</b>.</center></html>
\\
{{ ::omv6-rpi-18.jpg?800 |}}

\\ 
----
\\
<html><center>In the <b>Create window</b>, select the drop down arrow next to the <b>Device</b> field.</center></html>
<html><center>The on-board or add-on wireless interface will be the only interface in the list. Select it.</center></html>
\\
<html><center>In the <b>SSID</b> field, enter the SSID for the wireless network.</center></html>
<html><center>In the <b>Password</b> field, enter the WiFi encryption password.</center></html>
<html><center>Under <b>IPv4</b>, in the <b>Method</b> field, click on the drop down arrow and select <b>DHCP</b>.</center></html>
\\  

{{ ::omv6-rpi-19.jpg?800 |}}
\\ 

<html><center>Scroll down and click, <b>Save</b> and <b>Apply</b> the changes with the yellow banner.</center></html>
\\
At this point, the wireless interface will appear under **Network**, in the **Interfaces** window.  
Further configuration can be done, as needed, by clicking on the interface line and the edit button (pencil).
\\ 
\\
----




===== A Closing Note =====

We, who support the openmediavault project, hope that you’ll find your openmediavault server to be 
enjoyable, efficient, and easy to use.\\
\\
If you found this guide to be helpful, please consider a modest donation to support the 
hosting costs of this server (OMV-Extras) and the project (Openmediavault). \\
\\
**OMV-Extras.org**
\\
<html>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
<input type="hidden" name="cmd" value="_s-xclick">
<input type="hidden" name="hosted_button_id" value="2BQNGSC8HQJME">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" name="submit" title="PayPal - The safer, easier way to pay online!" alt="Donate with PayPal button" border="0">
<img alt="" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1" border="0">
</form>
</html>
\\
\\
**www.openmediavault.org**
\\
<html>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_blank">
<input name="cmd" type="hidden" value="_s-xclick" /> 
<input name="hosted_button_id" type="hidden" value="95MF5UQ66PW2E" /> 
<input style="border: 0px; padding: 0px;" alt="PayPal - The safer, easier way to pay online!" name="submit" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" type="image" /> 
<img loading="lazy" src="https://www.paypalobjects.com/de_DE/i/scr/pixel.gif" alt="" width="1" height="1" border="0" />
</form>
</html>
\\ 
\\
**Venmo: ryecoaaron** \\