mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 04:01:59 +00:00
Merge pull request #216 from Start9Labs/update/v033
Mac LAN fix, DIY and Flashing guide refactors
This commit is contained in:
kn0wmad
@@ -14,6 +14,12 @@ Video Guide:
|
||||
:width: 60%
|
||||
:alt: LAN setup prompt
|
||||
|
||||
#. In the resulting box, choose "System" from the "Keychain" dropdown menu. Then click "Add."
|
||||
|
||||
.. figure:: /_static/images/ssl/macos/mac-lan-setup0.png
|
||||
:width: 60%
|
||||
:alt: System Keychain
|
||||
|
||||
#. Enter your computer password when prompted. It will be imported into your mac's keychain.
|
||||
|
||||
.. figure:: /_static/images/ssl/macos/certificate_untrusted.png
|
||||
|
||||
@@ -1,71 +0,0 @@
|
||||
.. _flashing:
|
||||
|
||||
========
|
||||
Flashing
|
||||
========
|
||||
|
||||
Getting embassyOS
|
||||
-----------------
|
||||
After building your device, you need a copy of embassyOS.
|
||||
|
||||
* Visit the `latest embassyOS release page on Github <https://github.com/Start9Labs/embassy-os/releases/latest>`_ to download an image of embassyOS. It is ``eos.tar.gz`` for Linux/Mac and ``eos.zip`` for Windows.
|
||||
|
||||
Extracting the image
|
||||
--------------------
|
||||
|
||||
.. warning:: Make sure you have at least 16gb available on your drive.
|
||||
|
||||
Linux
|
||||
=====
|
||||
#. Download the ``eos.tar.gz`` file and open a terminal in the directory you save it to
|
||||
#. Extract with:
|
||||
|
||||
.. code-block::
|
||||
|
||||
tar -xzvf eos.tar.gz
|
||||
|
||||
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
|
||||
|
||||
.. code-block::
|
||||
|
||||
sha256sum eos.img
|
||||
|
||||
Mac
|
||||
===
|
||||
#. Download the ``eos.tar.gz`` file
|
||||
#. Right-click eos.tar.gz, click "open with," then click Archive Utility to extract
|
||||
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
|
||||
|
||||
.. code-block::
|
||||
|
||||
openssl dgst -sha256 eos.img
|
||||
|
||||
Windows
|
||||
=======
|
||||
#. Download the ``eos.zip`` file
|
||||
#. Right-click eos.zip and click "Extract all"
|
||||
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
|
||||
|
||||
.. code-block::
|
||||
|
||||
Get-FileHash eos.img
|
||||
|
||||
Installing embassyOS
|
||||
--------------------
|
||||
Once you have the embassyOS image, 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 eos.img.
|
||||
#. Click "Select Target" and select your 32GB microSD card.
|
||||
|
||||
.. warning:: Be certain you have selected the correct target microSD card. Whatever target you select will be completely erased and replaced with embassyOS.
|
||||
|
||||
#. 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, insert it into your Embassy's SD card slot, and continue to the :ref:`Initial Setup <initial-setup>` or :ref:`Update by reflashing <manual-update>` instructions.
|
||||
32
site/source/user-manual/flashing/flashing-firmware.rst
Normal file
32
site/source/user-manual/flashing/flashing-firmware.rst
Normal file
@@ -0,0 +1,32 @@
|
||||
.. _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/products/embassy-pro>`_.
|
||||
|
||||
The source code can be viewed on Purism's `firmware git repo <https://source.puri.sm/firmware/pureboot/-/tree/start9-intel-wifi>`_.
|
||||
|
||||
.. note:: USB drive *must* be formatted for FAT32
|
||||
|
||||
#. Download the firmware (``pureboot-librem_mini_v2-basic_usb_autoboot.rom.gz``) from `Purism's git repository <https://source.puri.sm/firmware/releases/-/tree/master/librem_mini_v2/custom>`_ and extract it.
|
||||
|
||||
#. Copy or move the resulting ``pureboot-librem_mini_v2-basic_usb_autoboot.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.
|
||||
|
||||
.. 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 PureBoot Basic Boot Menu appear. Continue to the main menu.
|
||||
|
||||
#. Select "Options -->."
|
||||
|
||||
#. Select "Flash/Update the BIOS".
|
||||
|
||||
#. Select "Flash the firmware with a new ROM, erase settings."
|
||||
|
||||
#. The system will ask if you want to proceed to flash the BIOS, select "Yes."
|
||||
|
||||
#. Choose the file that we downloaded earlier: ``pureboot-librem_mini_v2-basic_usb_autoboot.rom``.
|
||||
|
||||
#. Confirm you want to proceed by selecting "Yes."
|
||||
|
||||
#. The BIOS will be reflashed with the custom 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.
|
||||
89
site/source/user-manual/flashing/flashing-pi.rst
Normal file
89
site/source/user-manual/flashing/flashing-pi.rst
Normal file
@@ -0,0 +1,89 @@
|
||||
.. _flashing-pi:
|
||||
|
||||
==============
|
||||
Flashing (Raspberry Pi)
|
||||
==============
|
||||
This guide is for flashing embassyOS 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
|
||||
|
||||
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.
|
||||
45
site/source/user-manual/flashing/flashing-x86.rst
Normal file
45
site/source/user-manual/flashing/flashing-x86.rst
Normal 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, 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>`_.
|
||||
|
||||
.. 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. 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.
|
||||
|
||||
.. 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.
|
||||
50
site/source/user-manual/flashing/index.rst
Normal file
50
site/source/user-manual/flashing/index.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. _flashing:
|
||||
|
||||
========
|
||||
Flashing
|
||||
========
|
||||
|
||||
Here you will find our flashing guides for 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.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (Raspberry Pi)
|
||||
:link: flashing-pi
|
||||
:icon: scylla-icon scylla-icon--apps
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
Flash embassyOS for use on a Raspberry Pi
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (x86)
|
||||
:link: flashing-x86
|
||||
:icon: scylla-icon scylla-icon--overview
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
Flash embassyOS for use on an x86 machine
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (Firmware)
|
||||
:link: flashing-firmware
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: Librem Mini Firmware
|
||||
|
||||
Flash custom eOS firmware on an existing Librem Mini
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
|
||||
flashing-pi
|
||||
flashing-x86
|
||||
flashing-firmware
|
||||
|
||||
Appreciate what we're doing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
|
||||
@@ -15,7 +15,7 @@ Welcome to the embassyOS user manual. Here you will discover all that your Embas
|
||||
dashboard-overview
|
||||
updating
|
||||
backups/index
|
||||
flashing
|
||||
flashing/index
|
||||
reset-password
|
||||
customize
|
||||
managing-services
|
||||
|
||||
@@ -8,13 +8,12 @@ Reset Your Password
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
#. Obtain the latest copy of embassyOS by `downloading it from Github <https://github.com/Start9Labs/embassy-os/releases/latest>`_. Under `Assets` near the bottom of the page, click to download eos.tar.gz (on Linux/MacOS) or eos.zip (on Windows).
|
||||
#. Flash the downloaded image to your microSD card, using :ref:`this guide <flashing>`.
|
||||
#. Insert the microSD card into your Embassy and power it on.
|
||||
#. Download and flash the latest version of embassyOS, using the appropriate :ref:`flashing guide <flashing>` for your hardware.
|
||||
#. Power on your Embassy, ensuring it is plugged in to Ethernet.
|
||||
|
||||
.. note:: Embassy will power up and then initialize. Once complete, you will hear a _bep_ to indicate it is initialized and then a _chime_ sound to indicate it is online.
|
||||
.. note:: Embassy will power up and then initialize. If you have a speaker, you will hear first hear a _bep_ then a _chime_ sound to indicate the device is ready.
|
||||
|
||||
#. On your computer, open up a browser and go to http://embassy.local.
|
||||
#. Using a phone or computer connected to the same network, open up a browser and go to http://embassy.local.
|
||||
|
||||
#. Select "Recover".
|
||||
|
||||
@@ -26,19 +25,12 @@ Reset Your Password
|
||||
.. figure:: /_static/images/setup/screen1-restore_or_useexisting.jpg
|
||||
:width: 60%
|
||||
|
||||
#. As instructed, plug in your embassyOS data drive and it will be detected.
|
||||
#. Select your Embassy data drive
|
||||
|
||||
.. figure:: /_static/images/setup/screen4-select_storage.jpg
|
||||
:width: 60%
|
||||
|
||||
.. note:: If your SSD does not show up, unplug it from the USB port and plug it back in a different (blue) USB 3.0 port
|
||||
|
||||
#. Wait a moment while it reads the data from your drive.
|
||||
|
||||
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Enter and confirm a new password of at least 12 characters when prompted. Save this password somewhere safe.
|
||||
#. Enter and confirm a new password. This time, save it somewhere safe!
|
||||
|
||||
.. figure:: /_static/images/setup/screen5-set_password.jpg
|
||||
:width: 60%
|
||||
|
||||
Reference in New Issue
Block a user