Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 20:14:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Flashing guide updates (#386)

Browse Source
This commit is contained in:
kn0wmad
2023-05-23 17:14:55 +00:00
committed by GitHub
parent b51ac02c78
commit 404182cffa
9 changed files with 103 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
site/source/user-manual/flashing/flashing-x86.rst
View File

@@ -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.