mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 12:11:57 +00:00
Update flashing guide for all platforms
This commit is contained in:
kn0wmad
@@ -4,11 +4,11 @@
|
||||
Alt Marketplaces
|
||||
================
|
||||
|
||||
It is critical to Start9's mission that Start9 is **not** a central point of failure. The Marketplace is a critical piece of infrastructure and therefore EmbassyOS supports accessing alternative marketplaces.
|
||||
It is critical to Start9's mission that Start9 is **not** a central point of failure. The Marketplace is a critical piece of infrastructure and therefore embassyOS supports accessing alternative marketplaces.
|
||||
|
||||
.. caution:: Start9 is not responsible for issues encountered when downloading services from alternative marketplaces, and cannot provide support for services that are not from our official marketplace. Here be dragons!!
|
||||
|
||||
.. note:: Currently this change will only permit the downloading of *services* from alternative marketplaces. EmbassyOS itself may only be obtained from Start9.
|
||||
.. note:: Currently this change will only permit the downloading of *services* from alternative marketplaces. embassyOS itself may only be obtained from Start9.
|
||||
|
||||
#. Go to *Embassy > Marketplace Settings*.
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ The recommended method of backup (including with external drives) is to setup a
|
||||
.. figure:: /_static/images/config/physical-backup2.png
|
||||
:width: 60%
|
||||
|
||||
#. Enter your EmbassyOS master password.
|
||||
#. Enter your embassyOS master password.
|
||||
|
||||
.. figure:: /_static/images/config/physical-backup3.png
|
||||
:width: 60%
|
||||
|
||||
@@ -32,7 +32,7 @@ The Backups section allows you to create and restore :ref:`Embassy backups <back
|
||||
Settings
|
||||
========
|
||||
|
||||
The Settings section gives you access to :ref:`EmbassyOS Updates <updating-eos>`, Device Preferences, :ref:`connecting-lan`, :ref:`ssh`, :ref:`wifi`, and :ref:`alt-marketplaces`.
|
||||
The Settings section gives you access to :ref:`embassyOS Updates <updating-eos>`, Device Preferences, :ref:`connecting-lan`, :ref:`ssh`, :ref:`wifi`, and :ref:`alt-marketplaces`.
|
||||
|
||||
Insights
|
||||
========
|
||||
@@ -75,7 +75,7 @@ Use this tab to access your preferred Marketplace, where you can discover and in
|
||||
Notifications Tab
|
||||
-----------------
|
||||
|
||||
Notifications issued by EmbassyOS will appear in this tab. You can delete these notifications individually or all at once by clicking "Delete All".
|
||||
Notifications issued by embassyOS will appear in this tab. You can delete these notifications individually or all at once by clicking "Delete All".
|
||||
|
||||
.. figure:: /_static/images/walkthrough/notiftab.png
|
||||
:width: 60%
|
||||
|
||||
@@ -4,33 +4,57 @@
|
||||
Flashing
|
||||
========
|
||||
|
||||
Getting EmbassyOS
|
||||
Getting embassyOS
|
||||
-----------------
|
||||
After building your device, you need a copy of 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`.
|
||||
* 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 (eos.tar.gz)
|
||||
---------------------------------
|
||||
Extracting the image
|
||||
--------------------
|
||||
|
||||
* On Linux, open a terminal and run
|
||||
Linux
|
||||
=====
|
||||
#. Download the ``eos.tar.gz`` file and open a terminal in the directory you save it to
|
||||
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
|
||||
|
||||
.. code-block::
|
||||
|
||||
sha256sum eos.img.gz
|
||||
|
||||
#. Extract with:
|
||||
|
||||
.. code-block::
|
||||
|
||||
tar -xzvf eos.img.gz
|
||||
|
||||
* On Mac right click eos.tar.gz, click "open with" and click Unarchive
|
||||
Mac
|
||||
===
|
||||
#. Download the ``eos.tar.gz`` file
|
||||
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
|
||||
|
||||
.. figure:: /_static/images/unarchive.png
|
||||
:width: 40%
|
||||
.. code-block::
|
||||
|
||||
* On Windows download `7zip <https://www.7-zip.org/>`_ and use it to extract the image.
|
||||
openssl dgst -sha256 eos.img.gz
|
||||
|
||||
In all cases you should be left with the file eos.img
|
||||
#. Right-click eos.tar.gz, click "open with," then click Archive Utility to extract
|
||||
|
||||
Windows
|
||||
=======
|
||||
#. Download the ``eos.zip`` file
|
||||
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
|
||||
|
||||
.. code-block::
|
||||
|
||||
Get-FileHash eos.zip
|
||||
|
||||
#. Right-click eos.zip and click "Extract all"
|
||||
|
||||
In all cases you will be left with the file ``eos.img``
|
||||
|
||||
Installing embassyOS
|
||||
--------------------
|
||||
Once you have the EmbassyOS image, you will need to flash it onto a microSD card.
|
||||
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.
|
||||
@@ -43,7 +67,7 @@ Once you have the EmbassyOS image, you will need to flash it onto a microSD card
|
||||
#. 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.
|
||||
.. 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.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
User Manual
|
||||
===========
|
||||
|
||||
Welcome to the EmbassyOS user manual. Here you will discover all that your Embassy can do!
|
||||
Welcome to the embassyOS user manual. Here you will discover all that your Embassy can do!
|
||||
|
||||
.. toctree::
|
||||
:includehidden:
|
||||
|
||||
@@ -44,7 +44,7 @@ Powering On
|
||||
|
||||
* "chime" - Embassy is ready
|
||||
|
||||
.. caution:: If you followed the DIY guide and built EmbassyOS from source code, it may take up to 20 minutes to first initialize.
|
||||
.. caution:: If you followed the DIY guide and built embassyOS from source code, it may take up to 20 minutes to first initialize.
|
||||
|
||||
Claiming your Device
|
||||
--------------------
|
||||
|
||||
@@ -8,7 +8,7 @@ Managing Services
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
EmbassyOS provides a rich interface for managing installed Services.
|
||||
embassyOS provides a rich interface for managing installed Services.
|
||||
|
||||
Service Dashboard
|
||||
-----------------
|
||||
@@ -25,7 +25,7 @@ The Service Dashboard provides quick insight into the status and health of your
|
||||
* **Starting**: Service is in the process of starting up.
|
||||
* **Running**: Service is running.
|
||||
* **Launch UI**: If the service offer a User Interface (UI), and the UI is currently available, clicking this button will launch the UI in a new browser tab. Learn more about :ref:`Web UIs<web-ui>`.
|
||||
* **Health Checks**: This is a critical feature of EmbassyOS. Health Checks are configured by the service packager in order to quickly convey to the user what is happening with their service, as well as possible actions they may want to take. Learn more about :ref:`Health Checks <health-checks>`.
|
||||
* **Health Checks**: This is a critical feature of embassyOS. Health Checks are configured by the service packager in order to quickly convey to the user what is happening with their service, as well as possible actions they may want to take. Learn more about :ref:`Health Checks <health-checks>`.
|
||||
* **Dependencies**: Some services depend on the presence and proper configuration of other services to function. This section will inform you if all dependencies are satisfied and, if not, what to do about it. Learn more about :ref:`Dependencies <service-dependencies>`.
|
||||
* **Start / Stop**: Self-explanatory, use these buttons to start or stop a service.
|
||||
|
||||
@@ -53,7 +53,7 @@ Installing a Service
|
||||
Updating a Service
|
||||
------------------
|
||||
|
||||
.. note:: EmbassyOS will **NEVER** update a service without your consent.
|
||||
.. note:: embassyOS will **NEVER** update a service without your consent.
|
||||
|
||||
To see if an update is available for a service, you can visit the *Updates* section of the Marketplace or by visiting its Marketplace listing.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ 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.
|
||||
#. 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.
|
||||
#. Flash the downloaded image to your microSD card, using :ref:`this guide <flashing>`.
|
||||
#. Insert the microSD card into your Embassy and power it on.
|
||||
|
||||
@@ -26,7 +26,7 @@ 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.
|
||||
#. As instructed, plug in your embassyOS data drive and it will be detected.
|
||||
|
||||
.. figure:: /_static/images/setup/screen4-select_storage.jpg
|
||||
:width: 60%
|
||||
|
||||
@@ -27,7 +27,7 @@ Ride the Lightning
|
||||
|
||||
Available For
|
||||
.............
|
||||
- EmbassyOS
|
||||
- embassyOS
|
||||
|
||||
See the video at the top of this page for an intro to Lightning using RTL.
|
||||
|
||||
@@ -41,7 +41,7 @@ Spark
|
||||
Available For
|
||||
.............
|
||||
- Android
|
||||
- EmbassyOS
|
||||
- embassyOS
|
||||
- iOS
|
||||
|
||||
To use a Spark client, you still need to have Spark installed on the Embassy. The Spark service on Embassy is both a server (background service) and a client (the :ref:`Web UI<web-ui>`). Under Properties, there is a "Pairing URL". The first part of this is the server URL, and the end portion of it is the access key.
|
||||
@@ -53,7 +53,7 @@ Thunderhub
|
||||
|
||||
Available For
|
||||
.............
|
||||
- EmbassyOS
|
||||
- embassyOS
|
||||
|
||||
Download from your Embassy's Marketplace and follow the included Instructions.
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
.. _updating-eos:
|
||||
|
||||
==================
|
||||
Updating EmbassyOS
|
||||
Updating embassyOS
|
||||
==================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. note:: EmbassyOS will **NEVER** update itself without your approval. But we highly recommended keeping EmbassyOS up to date for the latest security and performance patches, as well as to take advantage of new features.
|
||||
.. note:: embassyOS will **NEVER** update itself without your approval. But we highly recommended keeping embassyOS up to date for the latest security and performance patches, as well as to take advantage of new features.
|
||||
|
||||
How to Update
|
||||
-------------
|
||||
|
||||
#. When a new version of EmbassyOS is available, a badge will appear on the "Embassy" tab.
|
||||
#. When a new version of embassyOS is available, a badge will appear on the "Embassy" tab.
|
||||
#. Go to *Embassy > Software Update*.
|
||||
|
||||
.. warning:: Ensure you have a stable Internet connection before beginning an OS update, and do not unplug your Embassy while EmbassyOS is downloading.
|
||||
.. warning:: Ensure you have a stable Internet connection before beginning an OS update, and do not unplug your Embassy while embassyOS is downloading.
|
||||
|
||||
#. Read the release notes and click "Begin Update".
|
||||
#. While the new version of EmbassyOS is downloading, you may continue to use your device as usual.
|
||||
#. While the new version of embassyOS is downloading, you may continue to use your device as usual.
|
||||
#. Once the download is complete, you will be prompted to restart Embassy.
|
||||
#. After restart, but before the web interface becomes available again, there may be a brief upgrade period of up to thirty minutes where data is transitioned. You will hear this sound every ten seconds until the upgrade is complete:
|
||||
|
||||
@@ -29,7 +29,10 @@ How to Update
|
||||
<source src="/_static/sounds/UPDATING.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
**Do not unplug or otherwise power off the embassy during this period.**
|
||||
|
||||
|
||||
**Do not unplug or otherwise power off the embassy during this period.**
|
||||
|
||||
#. Next, you may be prompted to refresh the browser window.
|
||||
|
||||
Disabling Auto Check for Updates
|
||||
@@ -49,7 +52,7 @@ This guide will cover how to recover existing Embassy 0.3.x service and user dat
|
||||
Manual Update by Re-flashing
|
||||
----------------------------
|
||||
|
||||
#. Obtain the latest copy of EmbassyOS with your product key included, either by `downloading <https://github.com/Start9Labs/embassy-os/releases/latest>`_ or `building from source <https://github.com/Start9Labs/embassy-os/tree/latest/build>`_.
|
||||
#. Obtain the latest copy of embassyOS with your product key included, either by `downloading <https://github.com/Start9Labs/embassy-os/releases/latest>`_ or `building from source <https://github.com/Start9Labs/embassy-os/tree/latest/build>`_.
|
||||
#. `Flash the downloaded image <../flashing>`_ to your microSD card.
|
||||
#. Insert the microSD card into your Embassy and power it on.
|
||||
|
||||
@@ -67,7 +70,7 @@ Manual Update by Re-flashing
|
||||
.. figure:: /_static/images/setup/screen3-use_existing.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Assuming you have you fully-intact EmbassyOS data drive plugged in, it will be automatically detected and begin the upgrade.
|
||||
#. Assuming you have you fully-intact embassyOS data drive plugged in, it will be automatically detected and begin the upgrade.
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Using your own hardware
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
This guide will cover how to upgrade from EmbassyOS version 0.2.x to version 0.3.x with your own equipment.
|
||||
This guide will cover how to upgrade from embassyOS version 0.2.x to version 0.3.x with your own equipment.
|
||||
|
||||
Hardware Requirements
|
||||
---------------------
|
||||
|
||||
@@ -8,7 +8,7 @@ Setup with Upgrade Kit
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
This guide will cover how to upgrade from EmbassyOS version 0.2.x to version 0.3.x.
|
||||
This guide will cover how to upgrade from embassyOS version 0.2.x to version 0.3.x.
|
||||
|
||||
.. note::
|
||||
If you purchased your own equipment please follow :ref:`this guide<upgrade-diy>`.
|
||||
|
||||
Reference in New Issue
Block a user