mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
Flashing guide updates (#386)
This commit is contained in:
kn0wmad
Binary file not shown.
|
Before Width: | Height: | Size: 57 KiB |
BIN
site/source/_static/images/flashing/raspi-asset.png
Normal file
BIN
site/source/_static/images/flashing/raspi-asset.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 75 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 57 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 57 KiB |
BIN
site/source/_static/images/flashing/x86_64-asset.png
Normal file
BIN
site/source/_static/images/flashing/x86_64-asset.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 72 KiB |
@@ -3,13 +3,13 @@
|
||||
===================
|
||||
Flashing (Firmware)
|
||||
===================
|
||||
This page is for existing Librem Mini owners ONLY. This will allow you to flash the custom firmware on your Librem to neutralize the Intel Management Engine (IME) and add embassyOS-specific tweaks to your system, such that it will operate just as an Embassy Pro bought from Start9 would. If you need hardware and want all the benefits listed here, you'll have to `buy an Embassy Pro <https://store.start9.com/products/embassy-pro>`_.
|
||||
This page is for existing Librem Mini owners ONLY. This will add StartOS-specific tweaks to your system, such that it will operate just as a Start9 Pure bought from the `Start9 Store <https://store.start9.com/products/server-pro>`_.
|
||||
|
||||
The source code can be viewed on Purism's `firmware git repo <https://source.puri.sm/firmware/releases/-/tree/master/librem_mini_v2/custom>`_.
|
||||
|
||||
.. note:: USB drive *must* be formatted for FAT32
|
||||
|
||||
#. `Download the firmware from Purism's git repository <https://source.puri.sm/firmware/releases/-/raw/master/librem_mini_v2/custom/pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-25.rom.gz>`_ and extract it.
|
||||
#. `Download the firmware from Purism's git repository <https://source.puri.sm/firmware/releases/-/raw/master/librem_mini_v2/custom/pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-25.rom.gz>`_ and extract it. You'll need a USB flash drive, formatted FAT32.
|
||||
|
||||
.. warning:: USB drive **must** be formatted for FAT32
|
||||
|
||||
#. Copy or move the resulting ``pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-25.rom`` file onto your USB drive, then eject the drive and insert it into your (powered down) Librem Mini. USB 3.0 (blue ports) are faster.
|
||||
|
||||
@@ -50,7 +50,7 @@ The source code can be viewed on Purism's `firmware git repo <https://source.pur
|
||||
.. figure:: /_static/images/flashing/flash_firmware-pro-step6-proceed_yes.jpg
|
||||
:width: 30%
|
||||
|
||||
#. The BIOS will be reflashed with the new firmware. This may take a few minutes. When complete, remove the firmware USB (and insert your embassyOS USB if you are ready to install), then select "OK" to complete the process.
|
||||
#. The BIOS will be reflashed with the new firmware. This may take a few minutes. When complete, remove the firmware USB (and insert your StartOS USB if you are ready to install), then select "OK" to complete the process.
|
||||
|
||||
.. figure:: /_static/images/flashing/flash_firmware-pro-step7-flashed_successfully.jpg
|
||||
:width: 30%
|
||||
@@ -3,68 +3,71 @@
|
||||
=======================
|
||||
Flashing (Raspberry Pi)
|
||||
=======================
|
||||
This guide is for flashing embassyOS to a micro SD card in order to install it on a Raspberry Pi.
|
||||
This guide is for flashing StartOS to a micro SD card in order to install it on a Raspberry Pi.
|
||||
|
||||
.. note:: You will need a micro SD card of at least 16GB in size, 32GB recommended
|
||||
.. note:: You will need a micro SD card of at least 16GB in size (32GB recommended) for the OS only (using an additional drive for storage), and at least 128GB is recommended if using the SD as your storage device.
|
||||
|
||||
Getting and Extracting the embassyOS Image
|
||||
------------------------------------------
|
||||
Visit the `Github release page <https://github.com/Start9Labs/embassy-os/releases/latest>`_ to find the latest embassyOS release. Select your OS below to get the correct Asset and extraction directions.
|
||||
Getting and Extracting the Image
|
||||
--------------------------------
|
||||
Visit the `Github release page <https://github.com/Start9Labs/start-os/releases/latest>`_ to find the latest StartOS release.
|
||||
|
||||
At the bottom of the page, under "Assets," download the ``raspberrypi.img.gz`` file.
|
||||
|
||||
.. figure:: /_static/images/flashing/raspi-asset.png
|
||||
:width: 60%
|
||||
:alt: Raspberry Pi Asset
|
||||
|
||||
Select your OS to continue:
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Linux
|
||||
|
||||
#. At the bottom of the page, under "Assets," download the ``embassyos_raspberrypi.tar.gz`` file and open a terminal in the directory you save it to.
|
||||
#. Open a terminal in the folder you downloaded to and extract with:
|
||||
|
||||
.. code-block::
|
||||
|
||||
tar -xzvf startos-0.3.4.2-bbd66e9-20230519_raspberrypi.img.gz
|
||||
|
||||
.. figure:: /_static/images/flashing/raspi-tar-asset.png
|
||||
:width: 60%
|
||||
|
||||
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
|
||||
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub (SHA256):
|
||||
|
||||
.. code-block::
|
||||
|
||||
sha256sum embassyos_raspberrypi.tar.gz
|
||||
|
||||
#. Extract with:
|
||||
|
||||
sha256sum startos-0.3.4.2-bbd66e9-20230519_raspberrypi.img
|
||||
|
||||
or (BLAKE3):
|
||||
|
||||
.. code-block::
|
||||
|
||||
tar -xzvf embassyos_raspberrypi.tar.gz
|
||||
b3sum startos-0.3.4.2-bbd66e9-20230519_raspberrypi.img
|
||||
|
||||
.. group-tab:: Mac
|
||||
|
||||
#. At the bottom of the page, under "Assets," download the ``embassyos_raspberrypi.tar.gz`` file.
|
||||
|
||||
.. figure:: /_static/images/flashing/raspi-tar-asset.png
|
||||
:width: 60%
|
||||
|
||||
#. Right-click ``startos-0.3.4.2-bbd66e9-20230519_raspberrypi.img.gz``, click "Open with," then click Archive Utility to extract.
|
||||
|
||||
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub by opening a terminal and entering:
|
||||
|
||||
.. code-block::
|
||||
|
||||
openssl dgst -sha256 embassyos_raspberrypi.tar.gz
|
||||
|
||||
#. Right-click ``embassyos_raspberrypi.tar.gz``, click "open with," then click Archive Utility to extract.
|
||||
openssl dgst -sha256 startos-0.3.4.2-bbd66e9-20230519_raspberrypi.img
|
||||
|
||||
.. group-tab:: Windows
|
||||
|
||||
#. At the bottom of the page, under "Assets," download the ``embassyos_raspberrypi.zip`` file
|
||||
|
||||
.. figure:: /_static/images/flashing/raspi-zip-asset.png
|
||||
:width: 60%
|
||||
|
||||
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub by opening a CMD terminal and entering:
|
||||
#. Open a ``cmd`` prompt "As Administrator" in the folder you saved the image to and use the following command to extract it:
|
||||
|
||||
.. code-block::
|
||||
|
||||
tar -xzvf startos-0.3.4.2-bbd66e9-20230519_raspberrypi.img.gz
|
||||
|
||||
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub by running:
|
||||
|
||||
.. code-block::
|
||||
|
||||
Get-FileHash embassyos_raspberrypi.zip
|
||||
|
||||
#. Right-click eos.zip and click "Extract all"
|
||||
Get-FileHash startos-0.3.4.2-bbd66e9-20230519_raspberrypi.img
|
||||
|
||||
Installing embassyOS
|
||||
--------------------
|
||||
Once you have extracted the embassyOS ``.img`` file, you will need to flash it onto a microSD card.
|
||||
Installing StartOS
|
||||
------------------
|
||||
Once you have extracted the StartOS ``.img`` file, you will need to flash it onto a microSD card.
|
||||
|
||||
#. Download `balenaEtcher <https://www.balena.io/etcher/>`_ onto your Linux, Mac, or Windows computer.
|
||||
|
||||
@@ -80,10 +83,10 @@ Once you have extracted the embassyOS ``.img`` file, you will need to flash it o
|
||||
|
||||
#. Click "Select Target" and select your microSD card.
|
||||
|
||||
.. warning:: BE ABSOLUTELY CERTAIN you have selected the correct target microSD card. Whatever target you select will be **COMPLETELY ERASED**!!
|
||||
.. warning:: BE ABSOLUTELY CERTAIN you have selected the correct target microSD card. Whatever drive you select will be **COMPLETELY ERASED**!!
|
||||
|
||||
#. Click "Flash!". You may be asked to (1) approve the unusually large disk target or (2) enter your password. Both are normal.
|
||||
#. Click "Flash!". You may be asked to approve the unusually large disk target and/or enter your password. Both are normal.
|
||||
|
||||
#. After the flash completes, you may remove the newly flashed micro SD card from any adapter, and insert it into your Embassy's SD card slot.
|
||||
#. After the flash completes, you may remove the newly flashed micro SD card from any adapter, and insert it into your server's SD card slot.
|
||||
|
||||
#. Finally, continue to the :ref:`Initial Setup <initial-setup>`, :ref:`Manual Update <manual-update>`, or :ref:`Reset Password <reset-password>` instructions - depending on your need.
|
||||
|
||||
@@ -3,26 +3,62 @@
|
||||
=================
|
||||
Flashing (x86_64)
|
||||
=================
|
||||
This guide is for flashing embassyOS to a USB drive in order to install it to an x86_64 architecture device. This will include most desktops, laptops, mini PCs, and servers. For an up-to-date list of known-good hardware, please check out this `forum post <https://community.start9.com/t/known-good-hardware-master-list-hardware-capable-of-running-embassyos-v0-3-3/66/2>`_.
|
||||
This guide is for flashing StartOS to a USB drive in order to install it to an x86_64 architecture device. This will include most desktops, laptops, mini PCs, and servers. For an up-to-date list of known-good hardware, please check out this `forum post <https://community.start9.com/t/known-good-hardware-master-list-hardware-capable-of-running-embassyos-v0-3-3/66>`_.
|
||||
|
||||
.. note:: You will need a USB drive of at least 16GB in size
|
||||
.. note:: You will need a USB drive of at least 8GB in size
|
||||
|
||||
Getting embassyOS
|
||||
-----------------
|
||||
#. Visit the `Github release page <https://github.com/Start9Labs/embassy-os/releases/latest>`_ to find the latest embassyOS release.
|
||||
Getting StartOS
|
||||
---------------
|
||||
Visit the `Github release page <https://github.com/Start9Labs/start-os/releases/latest>`_ to find the latest StartOS release.
|
||||
|
||||
#. Select ``embassyos_amd64.iso`` from the "Assets" section at the bottom of the release.
|
||||
At the bottom of the page, under "Assets," download the ``x86_64.iso`` or ``x86_64-nonfree.iso`` file. The former image contains no proprietary software (built for the Server Pure). As the title implies, the latter, ``nonfree`` image, contains non-free software. This may be required for your hardware, especially for Kiosk mode or WiFi.
|
||||
|
||||
.. figure:: /_static/images/flashing/amd64-asset.png
|
||||
.. figure:: /_static/images/flashing/x86_64-asset.png
|
||||
:width: 60%
|
||||
|
||||
Installing embassyOS
|
||||
--------------------
|
||||
Once you have the embassyOS image, you will need to flash it onto your USB drive.
|
||||
(OPTIONAL) Select your OS to verify the image (be sure to use the correct file name):
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Linux
|
||||
|
||||
Verify the checksum against the one listed on GitHub by opening a terminal in the folder you downloaded the image to and running:
|
||||
|
||||
(SHA256):
|
||||
|
||||
.. code-block::
|
||||
|
||||
sha256sum startos-0.3.4.2-bbd66e9-20230519_x86_64.iso
|
||||
|
||||
or (BLAKE3):
|
||||
|
||||
.. code-block::
|
||||
|
||||
b3sum startos-0.3.4.2-bbd66e9-20230519_x86_64.iso
|
||||
|
||||
.. group-tab:: Mac
|
||||
|
||||
Verify the checksum against the one listed on GitHub by opening a terminal in the folder you downloaded the image to and running:
|
||||
|
||||
.. code-block::
|
||||
|
||||
openssl dgst -sha256 startos-0.3.4.2-bbd66e9-20230519_x86_64.iso
|
||||
|
||||
.. group-tab:: Windows
|
||||
|
||||
Verify the checksum against the one listed on GitHub by opening a ``cmd`` prompt "As Administrator" in the folder you saved the image to and running:
|
||||
|
||||
.. code-block::
|
||||
|
||||
Get-FileHash startos-0.3.4.2-bbd66e9-20230519_x86_64.iso
|
||||
|
||||
Installing StartOS
|
||||
------------------
|
||||
Once you have the StartOS image, you will need to flash it onto your USB drive.
|
||||
|
||||
#. Download `balenaEtcher <https://www.balena.io/etcher/>`_ onto your Linux, Mac, or Windows computer.
|
||||
|
||||
#. Insert the USB drive into your computer.
|
||||
#. Insert your USB drive into your computer.
|
||||
|
||||
#. Open balenaEtcher.
|
||||
|
||||
@@ -30,16 +66,18 @@ Once you have the embassyOS image, you will need to flash it onto your USB drive
|
||||
:width: 60%
|
||||
:alt: Balena Etcher Dashboard
|
||||
|
||||
#. Click "Select Image" and select the ``embassyos_amd64.iso`` file you just downloaded.
|
||||
#. Click "Select Image" and select the ``.iso`` file you just downloaded.
|
||||
|
||||
#. Click "Select Target" and select your USB drive, checking the size to make sure it's the correct drive.
|
||||
|
||||
.. warning:: BE ABSOLUTELY CERTAIN you have selected the correct target flash drive. Whatever target you select will be **COMPLETELY ERASED**!!
|
||||
|
||||
#. Click "Flash!". You may be asked to (1) approve the unusually large disk target or (2) enter your password. Both are normal.
|
||||
#. Click "Flash!". You may be asked to approve the unusually large disk target and/or enter your password. Both are normal.
|
||||
|
||||
#. After this completes, you may remove the newly flashed drive from your computer, insert it into the device you intend to install embassyOS onto. You will need to allow/prioritize "Legacy boot" from your BIOS. Look up your device or motherboard online for how to access the BIOS and make the change. This is *not* necessary when flashing the Embassy Pro.
|
||||
#. After this completes, you may remove the newly flashed drive from your computer, insert it into the device you intend to install StartOS onto.
|
||||
|
||||
.. note:: Always perfer the fastest available USB 3.0 port - typically this is blue or labeled "SS" (SuperSpeed)
|
||||
.. note:: Always perfer the fastest available USB 3.0+ port - typically this is blue or labeled "SS" (SuperSpeed)
|
||||
|
||||
.. tip:: Occasionally, you may need to make some changes in your BIOS, such as turning off Secure Boot, or allowing USB boot for install. See the `Community Hub <https://community.start9.com>`_ for guides or to get help.
|
||||
|
||||
#. Finally, continue to the :ref:`Initial Setup <initial-setup>`, :ref:`Manual Update <manual-update>`, or :ref:`Reset Password <reset-password>` instructions - depending on your need.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Flashing
|
||||
========
|
||||
|
||||
Here you will find our flashing guides for Raspberry Pi and x86_64 (most desktops, laptops, mini PCs, servers, etc) architectures. Librem Mini owners can use the firmware flashing guide to get embassyOS-specific firmware.
|
||||
Here you will find our flashing guides for the Raspberry Pi and x86_64 (most desktops, laptops, mini PCs, servers, etc) architectures. Librem Mini owners can use the firmware flashing guide to get StartOS-specific firmware.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
@@ -19,7 +19,7 @@ Here you will find our flashing guides for Raspberry Pi and x86_64 (most desktop
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
Flash embassyOS for use on a Raspberry Pi
|
||||
Flash StartOS for use on a Raspberry Pi
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (x86_64)
|
||||
@@ -28,7 +28,7 @@ Here you will find our flashing guides for Raspberry Pi and x86_64 (most desktop
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
Flash embassyOS for use on an x86_64 machine
|
||||
Flash StartOS for use on an x86_64 machine
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (Firmware)
|
||||
@@ -37,7 +37,7 @@ Here you will find our flashing guides for Raspberry Pi and x86_64 (most desktop
|
||||
:class: large-4
|
||||
:anchor: Librem Mini Firmware
|
||||
|
||||
Flash custom eOS firmware on an existing Librem Mini
|
||||
Flash the custom firmware for StartOS on an existing Librem Mini
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
Reference in New Issue
Block a user