mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 04:01:59 +00:00
Docs touchups: reset password flow, flashing page (#163)
* Fixed typo, fixed Raspi 4 power supply amperage description. * Typo fixes, links fixes, formatting fixes. * Add poetry.lock * FAQ Touchups Round 1 * Update Docs: Reset Password flow, dedicated flashing page * More touchups to User Manual * Navigation link fix * Curate FAQ occurances of 'The Embassy', flashing & reset password pages. * flashing, updating, iso github references * Github links updates... again * Link typo * FAQ basic use - support wording * Remove reference to image server Co-authored-by: kn0wmad <kn0wmad@protonmail.com>
This commit is contained in:
gStart9
33
site/source/user-manual/flashing.rst
Normal file
33
site/source/user-manual/flashing.rst
Normal file
@@ -0,0 +1,33 @@
|
||||
.. _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`.
|
||||
|
||||
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 your downloaded copy of EmbassyOS.
|
||||
#. 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 micro SD from the 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.
|
||||
@@ -15,6 +15,8 @@ Welcome to the EmbassyOS user manual. Here you will discover all that your Embas
|
||||
dashboard-overview
|
||||
updating
|
||||
backups/index
|
||||
flashing
|
||||
reset-password
|
||||
customize
|
||||
managing-services
|
||||
service-guides/index
|
||||
|
||||
@@ -77,7 +77,7 @@ Claiming your Device
|
||||
|
||||
#. Create your *permanent* master password and click "Finish".
|
||||
|
||||
.. warning:: There is currently no way to change your password. Choose a strong master password. Write it down. Store it somewhere safe. DO NOT LOSE IT. If you lose this password, you may be forced to reset the device, resulting in permanent loss of data. **This one responsibility is the price of sovereignty.**
|
||||
.. warning:: Choose a strong master password. Write it down. Store it somewhere safe. DO NOT LOSE IT.
|
||||
|
||||
.. figure:: /_static/images/setup/setup3.png
|
||||
:width: 60%
|
||||
|
||||
46
site/source/user-manual/reset-password.rst
Normal file
46
site/source/user-manual/reset-password.rst
Normal file
@@ -0,0 +1,46 @@
|
||||
.. _reset-password:
|
||||
|
||||
===================
|
||||
Reset Your Password
|
||||
===================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
#. Obtain the latest copy of EmbassyOS with your product key included, by `downloading it from Github <https://github.com/Start9Labs/embassy-os/releases/latest>`_.
|
||||
#. Flash the downloaded image to your microSD card, using :ref:`this guide <flashing>`.
|
||||
#. Insert the microSD card into your Embassy and power it on.
|
||||
|
||||
.. 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.
|
||||
|
||||
#. On your computer, open up a browser and go to http://embassy.local.
|
||||
#. When prompted, enter your Product Key:
|
||||
|
||||
.. figure:: /_static/images/setup/migrate0.png
|
||||
:width: 60%
|
||||
|
||||
#. Select "Recover".
|
||||
|
||||
.. figure:: /_static/images/setup/migrate1.png
|
||||
:width: 60%
|
||||
|
||||
#. As instructed, plug in your EmbassyOS data drive and you will receive a popup declaring that a valid data drive has been detected. Click "Use Drive" from the pop-up. If you don't see the drive, you may get a message asking you to unplug, then plug back in the drive, and refresh the page.
|
||||
|
||||
.. figure:: /_static/images/setup/use-drive.png
|
||||
:width: 60%
|
||||
|
||||
#. Wait a moment while it reads the data from your drive.
|
||||
|
||||
.. figure:: /_static/images/setup/pw_reset-s4-importing_drive.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Enter and confirm a new password of at least 12 characters when prompted. Save this password somewhere safe.
|
||||
|
||||
.. figure:: /_static/images/setup/pw_reset-s5-set_password.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Your password change is complete!
|
||||
|
||||
.. figure:: /_static/images/setup/pw_reset-s6-reset_complete.jpg
|
||||
:width: 60%
|
||||
@@ -35,11 +35,13 @@ By default, Embassy will automatically check for available updates. To disable t
|
||||
|
||||
This guide will cover how to recover existing Embassy 0.3.x service and user data (on an SSD) to a new OS install (sd card).
|
||||
|
||||
.. _manual-update:
|
||||
|
||||
Manual Update by Re-flashing
|
||||
----------------------------
|
||||
|
||||
#. Obtain the latest copy of EmbassyOS with your product key included, either by `downloading <https://images.start9.com>`_ or `building from source <https://github.com/Start9Labs/embassy-os/tree/master/build>`_.
|
||||
#. Flash the downloaded image to your microSD card.
|
||||
#. 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.
|
||||
|
||||
.. note:: Embassy will power up and then initialize, a process of less than 5 minutes if you purchased an image, or about 10-20 minutes if you built from source. Once complete you will hear a _bep_ to indicate it is initialized and then a _chime_ sound to indicate it is online.
|
||||
|
||||
Reference in New Issue
Block a user