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

Mac LAN fix, DIY and Flashing guide refactors

Browse Source
This commit is contained in:
kn0wmad
2022-12-08 16:39:13 -07:00
parent a869c9825a
commit ad3b15e065
17 changed files with 356 additions and 250 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
site/source/user-manual/flashing/flashing-arm.rst Normal file
View File

@@ -0,0 +1,89 @@
.. _flashing-arm:
==============
Flashing (ARM)
==============
This guide is for flashing embassyOS to a micro SD card in order to install it to an ARM architecture device, namel the Raspberry Pi. Support for other ARM devices will come in future. 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>`_.
.. note:: You will need a micro SD card of at least 16GB in size, 32GB recommended
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.
.. 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.
.. figure:: /_static/images/flashing/raspi-tar-asset.png
:width: 60%
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
.. code-block::
sha256sum embassyos_raspberrypi.tar.gz
#. Extract with:
.. code-block::
tar -xzvf embassyos_raspberrypi.tar.gz
.. 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%
#. (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.
.. 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:
.. code-block::
Get-FileHash embassyos_raspberrypi.zip
#. Right-click eos.zip and click "Extract all"
Installing embassyOS
--------------------
Once you have extracted the embassyOS ``.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.
#. Insert the microSD card into your computer, either directly or using an adapter.
#. Open balenaEtcher.
.. figure:: /_static/images/diy/balena.png
:width: 60%
:alt: Balena Etcher Dashboard
#. Click "Select Image" and select the ``.img`` file.
#. 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**!!
#. Click "Flash!". You may be asked to (1) approve the unusually large disk target or (2) 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.
#. 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.

22
site/source/user-manual/flashing/flashing-firmware.rst Normal file
View File

@@ -0,0 +1,22 @@
.. _flashing-firmware:
===================
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>`_.
The source code can be viewed on Purism's `firmware git repo <https://source.puri.sm/firmware/pureboot/-/tree/start9-intel-wifi>`_.
.. note:: You will need a USB drive
#. Download the firmware from `Purism's git repository <https://source.puri.sm/firmware/releases/-/tree/master/librem_mini_v2/custom>`_. It does not need to be extracted.
* ``pureboot-librem_mini_v2-basic_usb_autoboot.rom.gz``
#. Copy or move the 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.
.. note:: You'll need a monitor and keyboard plugged into your Librem Mini for this operation
#. Turn on the Librem Mini while pressing the ``ESC`` key on the keyboard repeatedly, until you see the following screen:
.. figure::

45
site/source/user-manual/flashing/flashing-x86.rst Normal file
View File

@@ -0,0 +1,45 @@
.. _flashing-x86:
==============
Flashing (x86)
==============
This guide is for flashing embassyOS to a USB drive in order to install it to an x86 architecture device. This will include most desktops, laptops, mini PCs, servers, and virtualization solutions. 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>`_.
.. note:: You will need a USB drive of at least 16GB in size
Getting embassyOS
-----------------
#. Visit the `Github release page <https://github.com/Start9Labs/embassy-os/releases/latest>`_ to find the latest embassyOS release.
#. Select ``embassyos_amd64.iso`` from the "Assets" section at the bottom of the release.
.. figure:: /_static/images/flashing/amd64-asset.png
:width: 60%
Installing embassyOS
--------------------
Once you have the embassyOS 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.
#. Open balenaEtcher.
.. figure:: /_static/images/diy/balena.png
:width: 60%
:alt: Balena Etcher Dashboard
#. Click "Select Image" and select the ``embassyos_amd64.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.
#. After this completes, you may remove the newly flashed drive from your computer, insert it into the device you intend to install embassyOS onto.
.. note:: Always perfer the fastest available USB 3.0 port - typically this is blue or labeled "SS" (SuperSpeed)
#. 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.

15
site/source/user-manual/flashing/index.rst Normal file
View File

@@ -0,0 +1,15 @@
.. _flashing:
========
Flashing
========
Here you will find our flashing guides for ARM (Raspberry Pi) and x86 (most desktops, laptops, mini PCs, servers, etc) architectures. Librem Mini owners can use the firmware flashing guide to get embassyOS-specific firmware.
.. toctree::
:includehidden:
:maxdepth: 2
flashing-arm
flashing-x86
flashing-firmware