omv6:alternate_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>6}}


====== Alternate Install - OMV6 on a Raspberry PI ======
\\ 
\\
{{ :omv6ug_-top.jpg?600 |}}
\\



===== Introduction =====

On rare occasions, the "Current Image", downloaded by the Raspberry PI imager, may have a minor flaw associated with it which may cause issues with an OMV build.  Finding and fixing an OS release flaw, along with pushing out a new image, may take some time.  In such an event, this alternate build process might be useful as a workaround. It uses a fixed, older, and well tested image that is fully updated to the lasted packages as part of the build 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 =====

OMV6 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 are preferred for backup).

To get started, a few utilities are needed to check, expand, and work with the image.

  * Raspberry PI OS images are compressed with a .zip extension.  Users will need a utility like [[https://www.7-zip.org/|7-Zip]] to decompress the image.  7-Zip is installable on a Windows client.
  * To check the decompressed image, an [[https://md5-sha-checksum-utility.en.lo4d.com/windows|MD5 – SHA Checksum utility]] is needed.  This utility is portable, meaning it's not necessary to install it, but it may require support files.  Simply run the executable.
  * [[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 files. SDformatter 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. 
  * To burn a Raspberry PI OS image to an SD-card, [[https://gitlab.com/bztsrc/usbimager/raw/binaries/usbimager_1.0.8-i686-win-gdi.zip|USBimager]] is recommended.  (It burns the image and verifies it in one process.)  USBimager for Windows is portable, with no required installation.  Extract the archive with 7zip and use the executable file (usbimager.exe)
  * [[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 the second is 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 |}}
\\
\\
<html>
<body>
  <table width="100%" border="0">
    <tr>
      <td colspan="2" style="background-color:#FFB663;height:30px;">
        <strong><span style="color:#8B0000;font-size:150%;">&#160; Important Release Note </span></strong>
      </td>
    </tr>
    <tr>
      <td style="background-color:#FFE4A6;height:25px;width:380px;">
        This build guide uses the Raspberry PI OS 2022-01-28 64bit image.  Download the image →  <a href="https://downloads.raspberrypi.org/raspios_lite_arm64/images/raspios_lite_arm64-2022-01-28/2022-01-28-raspios-bullseye-arm64-lite.zip">here</a><br/>
The SHA256 check sum is: d694d2838018cf0d152fe81031dba83182cee79f785c033844b520d222ac12f5<br/>
This image will build in accordance with this guide and the build will be a fully updated Raspberry PI OS install when complete.<br/>
    </tr>
  </table>
</body>
</html>

{{ :divider2.png?800 |}}

\\ 


===== Working With the Image File =====
\\ 

==== Verify the Archive file ====
 

After downloading the **Raspbian OS Lite** zip archive, run a SHA hash to check for file corruption that may have occurred during the download.  
The Raspberry PI project provides a **SHA-256** hash check number for the downloaded Zip archive file.

**Beginners Note - DO NOT SKIP THE FOLLOWING STEP.**  

The chance of image corruption is highest when downloading and it's pointless to build a server with flawed software.  Even the slightest corruption of the image may ruin your installation and the effects may not be noticed until well after your server is built and in use.  Headaches can be avoided by checking the zip archive.

{{ :divider2.png?600 |}}

Verify the downloaded Zip file with the [[https://md5-sha-checksum-utility.en.lo4d.com/windows|MD5 & SHA checksum utility]].  Note that it's possible to “drag and drop” the file name into the utility, on the **File** line.  Otherwise, use the **Browse** button and navigate to the zip file.

{{ :omv6-rpi-1.jpg?600 |}}

With the previously noted down SHA-256 hash, or by referencing the [[https://www.raspberrypi.org/software/operating-systems/|Raspberry PI OS]] Raspberry PI OS Web page, compare the utility's result with the SHA-256 hash provided on the download page.  
For this particular example it's: **008d7377b8c8b853a6663448a3f7688ba98e2805949127a1d9e8859ff96ee1a9** 

With a SHA-256 match, the downloaded file is verified.

\\ 
\\ 


==== Decompress the Image ====

<html><center>Raspberry PI OS images are compressed and will need to be extracted with 7-Zip.  (The following process assumes 7-Zip has been installed.)</center></html>
<html><center>Highlight the compressed file, right click the mouse, and make the menu selections shown below.</center></html>

{{ :omv6-rpi-2.jpg?600 |}}

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

<html><center>The result of the above action is the extraction of an uncompressed folder, with the image file inside.  Open that folder.  The image file's extension is <strong>.img</strong></center></html>

{{ ::omv6-rpi-3.jpg?700 |}}


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

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


<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 more than once.  Cancel each of these attempts. 
    </tr>
  </table>
</body>
</html>
\\
Using SDFormatter, do a clean format:
\\

<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 "trim" operation on the card which cleans up remnants of deleted or previously existing 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 <strong>endless verify</strong> 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.  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 |}}

==== Flashing Raspberry PI OS Buster Lite onto an SD-card ====


<html><center><strong>Start USBImager:</strong></center></html>

<html><center>Using the highlighted file selector box, select and open the decompressed image to be flashed.
</center></html>
{{ ::omv6-rpi-9.jpg?400 |}}

{{ :divider2.png?600 |}}

<html><center>Using the drop down select the SD-card.</center></html>
<html><center>The <strong>verify</strong> box should be checked.</center></html>

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

{{ :divider2.png?600 |}}

<html><center>Click the <strong>Write</strong> button to flash the image.</center></html>

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

{{ :divider2.png?600 |}}

<html><center>USBImager will write and verify the image.</center></html>
{{ ::omv6-rpi-12.jpg?400 |}

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

  
{{ :divider2.png?800 |}}


===== Enabling Raspberry PI OS's SSH Server for Remote Access =====

Raspberry PI OS is designed to have it's configuration finalized with a monitor and keyboard attached.  However, there's no need for a monitor and keyboard to support an OMV installation.   OMV was designed, from the ground up, to run as a headless server.

For the sake of convenience, Raspberry PI OS can be configured to enable it's SSH server on first boot, so the server can be accessed remotely with PuTTY.  The following will enable SSH access.

{{ :divider2.png?600 |}}

To insure the file system on the Raspberry PI OS flashed card is recognized, **unplug** the SD-card for a few moments and plug it back into the PC used to flash the SD-Card.  
<html><center>Open a file manager window, displaying the file contents of the of the SD-card.</center></html>
<html><center>Right click in the files side (right window) and select, <b>New</b>, and <b>Text Document</b>.</center></html>

{{ :omv6-rpi-13.jpg?700 |}}

{{ :divider2.png?600 |}}

<html><center>A file is created.  Name the file <b>ssh</b> with no extension.</center></html>

{{ :omv6-rpi-14.jpg?700 |}}

<html><center>Confirm, as shown above, that the file <b>ssh</b> has no extension.  (This will mean removing <b>.txt</b> from the file name.)</center></html>

{{ :divider2.png?600 |}}

<html><center>The following warning may pop up, regarding a file without an extension.</center></html>
{{ ::R-PI7_SSH_TXT_File3.jpg?400 |}}
<html><center>Ignore it and select <b>“Yes”</b>.</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 an example.)</center></html>

{{ ::omv6-rpi-15.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 will 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**.

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><strong>Open PuTTY and type in the IP address as previously found.</strong></center></html>

{{ ::omv6-rpi-16.jpg?500 |}}
\\
<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> Login as: <strong>pi</strong></center></html>  
<html><center>The Raspberry PI OS default password is: <strong>raspberry</strong></center></html> 

{{ ::omv6-rpi-17.jpg?600 |}}

\\


After logging in with the default password, it's __strongly__ recommended that the password for the **pi** user be changed.  

On the command line, type;

''passwd''

Re-enter the current password **raspberry**, then follow the prompts to enter and confirm a new password for the **pi** user password.  (Remember this password.)

\\ 
\\


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

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

''sudo apt-get update''  

''sudo apt-get upgrade -y ''


<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;">
        The following command applies to R-PI <b>3 models</b> only, but there's no penalty if it runs on other models.
    </tr>
  </table>
</body>
</html>
\\
''sudo rm -f /etc/systemd/network/99-default.link'' \\
\\
When the above commands above 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 for the Raspberry 
        PI OS installation, look at your DHCP server to see if a “new” IP address has been assigned.</p>
        In some cases, the 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=omv6:new_user_guide|Getting Started with Openmediavault 6]] guide, starting in the section titled → [[https://wiki.omv-extras.org/doku.php?id=omv6:new_user_guide#initial_configuration|Initial Configuration]].
  * All users are encouraged to review this resource → [[https://wiki.omv-extras.org/doku.php?id=omv6:utilities_maint_backup|Utilities, Maintenance & Backup]] for an easy process to clone a flash boot drive 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, <strong>Save</strong>.</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).
\\ 

{{ :divider2.png?800 |}}

===== 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.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>
\\
\\
**Venmo: ryecoaaron** \\


\\