Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 02:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated upgrade, initial setup, diy, and password reset guides (#179)

Browse Source 
* Updated upgrade, initial setup, diy, and password reset guides with new screens/032 flow

* deleting 0.3.1.x series video for now

Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
This commit is contained in:
gStart9
2022-10-08 01:36:11 +00:00
committed by GitHub
parent 252c1d3509
commit f9e869975e
13 changed files with 67 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
poetry.lock generated
View File

@@ -613,7 +613,7 @@ python-versions = ">= 3.7"
[[package]] [[package]]
name = "typing-extensions" name = "typing-extensions"
version = "4.3.0" version = "4.4.0"
description = "Backported and Experimental Type Hints for Python 3.7+" description = "Backported and Experimental Type Hints for Python 3.7+"
category = "main" category = "main"
optional = false optional = false
@@ -946,8 +946,8 @@ tornado = [
{file = "tornado-6.2.tar.gz", hash = "sha256:9b630419bde84ec666bfd7ea0a4cb2a8a651c2d5cccdbdd1972a0c859dfc3c13"}, {file = "tornado-6.2.tar.gz", hash = "sha256:9b630419bde84ec666bfd7ea0a4cb2a8a651c2d5cccdbdd1972a0c859dfc3c13"},
] ]
typing-extensions = [ typing-extensions = [
{file = "typing_extensions-4.3.0-py3-none-any.whl", hash = "sha256:25642c956049920a5aa49edcdd6ab1e06d7e5d467fc00e0506c44ac86fbfca02"}, {file = "typing_extensions-4.4.0-py3-none-any.whl", hash = "sha256:16fa4864408f655d35ec496218b85f79b3437c829e93320c7c9215ccfd92489e"},
{file = "typing_extensions-4.3.0.tar.gz", hash = "sha256:e6d2677a32f47fc7eb2795db1dd15c1f34eff616bcaf2cfb5e997f854fa1c4a6"}, {file = "typing_extensions-4.4.0.tar.gz", hash = "sha256:1511434bb92bf8dd198c12b1cc812e800d4181cfcb867674e0f8279cc93087aa"},
] ]
urllib3 = [ urllib3 = [
{file = "urllib3-1.26.12-py2.py3-none-any.whl", hash = "sha256:b930dd878d5a8afb066a637fbb35144fe7901e3b209d1cd4f524bd0e9deee997"}, {file = "urllib3-1.26.12-py2.py3-none-any.whl", hash = "sha256:b930dd878d5a8afb066a637fbb35144fe7901e3b209d1cd4f524bd0e9deee997"},

BIN
site/source/_static/images/setup/screen0-startfresh_or_recover.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

BIN
site/source/_static/images/setup/screen1-restore_or_useexisting.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 32 KiB

BIN
site/source/_static/images/setup/screen3-restore_drive.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 96 KiB

BIN
site/source/_static/images/setup/screen4-select_storage.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

0
site/source/_static/images/setup/pw_reset-s5-set_password.jpg → site/source/_static/images/setup/screen5-set_password.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 48 KiB

BIN
site/source/_static/images/setup/screen6-storage_initialize.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 37 KiB

BIN
site/source/_static/images/setup/upgrade6.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 71 KiB

2
site/source/diy.rst
View File

@@ -64,7 +64,7 @@ Getting EmbassyOS
After building your device, you need a copy of EmbassyOS. After building your device, you need a copy of EmbassyOS.
* Visit `images.start9.com <https://images.start9.com>`_ and enter the product key ``xxxxxxxx`` (all lower case) to download an image of EmbassyOS. * Download the latest release of EmbassyOS from `our github <https://github.com/start9labs/embassy-os/releases/latest>`_, scroll to the Assets section, and download eos.tar.gz.
Installing EmbassyOS Installing EmbassyOS
-------------------- --------------------

31
site/source/user-manual/initial-setup.rst
View File

@@ -8,11 +8,6 @@ Initial Setup
:depth: 2 :depth: 2
:local: :local:
Check out the video below, and follow along with the steps in this guide to setup your new Embassy!
.. youtube:: cWFLUH6jrqA
:width: 100%
Powering On Powering On
----------- -----------
@@ -51,38 +46,36 @@ Claiming your Device
.. caution:: Sometimes a router will have a "guest WiFi network," which might be different than the network your Embassy is placed on via ethernet. .. caution:: Sometimes a router will have a "guest WiFi network," which might be different than the network your Embassy is placed on via ethernet.
#. Visit http://embassy.local from your web browser. You will be prompted to enter your :ref:`Product Key<product-key>`. If you purchased a device from Start9, your Product Key is engraved on the bottom of your device. #. Visit http://embassy.local from your web browser.
.. figure:: /_static/images/setup/setup0.png
:width: 60%
:alt: Enter Product Key
.. note::
The product key is used to discover your Embassy's IP address on the Local Area Network using a hashing function and a protocol named :ref:`MDNS (or Zeroconf) <mdns>`.
#. Select "Start Fresh" #. Select "Start Fresh"
.. figure:: /_static/images/setup/setup1.png .. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
:width: 60% :width: 60%
:alt: Fresh Install :alt: Fresh Install
.. note:: The "Recover" button is used for :ref:`migrating from 0.2.x <upgrade-02>` and :ref:`restoring from backup <backup-restore>`. .. note:: The "Recover" button is used for :ref:`migrating from 0.2.x <upgrade-02>` or :ref:`restoring from backup <backup-restore>`.
#. Select your storage drive. You should only have one drive plugged into your Embassy at this time, but always verify it is what you expect before clicking (such as, is it a 1TB drive?) #. Select your storage drive. You should only have one drive plugged into your Embassy at this time, but always verify it is what you expect before clicking (such as, is it a 1TB drive?)
.. figure:: /_static/images/setup/setup2.png .. figure:: /_static/images/setup/screen4-select_storage.jpg
:width: 60% :width: 60%
:alt: Select Drive :alt: Select Drive
#. Create your *permanent* master password and click "Finish". #. Create a master password for your Embassy and click "Finish".
.. warning:: Choose a strong master password. Write it down. Store it somewhere safe. DO NOT LOSE IT. .. warning:: Choose a strong master password. Write it down. Store it somewhere safe. DO NOT LOSE IT.
.. figure:: /_static/images/setup/setup3.png .. figure:: /_static/images/setup/screen5-set_password.jpg
:width: 60% :width: 60%
:alt: Enter a New Password :alt: Enter a New Password
#. The drive will be initialized for a few minutes
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
:alt: SSD Initialization
#. Your Embassy is now a private website on the private web! Continue to the section on :ref:`connecting` to learn more about using your Embassy over Tor and LAN. #. Your Embassy is now a private website on the private web! Continue to the section on :ref:`connecting` to learn more about using your Embassy over Tor and LAN.
.. tip:: Click "Download This Page" to save your Embassy address and certificate info on your computer. .. tip:: Click "Download This Page" to save your Embassy address and certificate info on your computer.

23
site/source/user-manual/reset-password.rst
View File

@@ -8,36 +8,39 @@ Reset Your Password
:depth: 2 :depth: 2
:local: :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>`_. #. 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>`. #. Flash the downloaded image to your microSD card, using :ref:`this guide <flashing>`.
#. Insert the microSD card into your Embassy and power it on. #. 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. .. 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. #. 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". #. Select "Recover".
.. figure:: /_static/images/setup/migrate1.png .. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
:width: 60% :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. #. Select "Use Existing Drive".
.. figure:: /_static/images/setup/use-drive.png .. figure:: /_static/images/setup/screen1-restore_or_useexisting.jpg
:width: 60% :width: 60%
#. As instructed, plug in your EmbassyOS data drive and it will be detected.
.. 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. #. Wait a moment while it reads the data from your drive.
.. figure:: /_static/images/setup/pw_reset-s4-importing_drive.jpg .. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60% :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 of at least 12 characters when prompted. Save this password somewhere safe.
.. figure:: /_static/images/setup/pw_reset-s5-set_password.jpg .. figure:: /_static/images/setup/screen5-set_password.jpg
:width: 60% :width: 60%
#. Your password change is complete! #. Your password change is complete!

41
site/source/user-manual/upgrade-02/upgrade-diy.rst
View File

@@ -8,7 +8,7 @@ Using your own hardware
:depth: 2 :depth: 2
:local: :local:
This guide will cover how to upgrade from EmbassyOS version 0.2.x to version 0.3.0 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 Hardware Requirements
--------------------- ---------------------
@@ -20,14 +20,14 @@ Hardware Requirements
#. `1TB solid state drive <https://www.amazon.com/Crucial-MX500-NAND-SATA-Internal/dp/B078211KBB>`_ minimum, 2TB+ recommended. #. `1TB solid state drive <https://www.amazon.com/Crucial-MX500-NAND-SATA-Internal/dp/B078211KBB>`_ minimum, 2TB+ recommended.
#. `Connector <https://www.amazon.com/Sabrent-2-5-Inch-Adapter-Optimized-EC-SSHD/dp/B011M8YACM>`_ or `enclosure <https://www.amazon.com/gp/product/B07T9D8F6C>`_ for your drive. #. `Connector <https://www.amazon.com/Sabrent-2-5-Inch-Adapter-Optimized-EC-SSHD/dp/B011M8YACM>`_ or `enclosure <https://www.amazon.com/gp/product/B01LY97QE8>`_ for your drive.
#. `SD card adapter <https://www.amazon.com/gp/product/B000WR3Z3A>`_ for getting data from your SD card. #. `SD card adapter <https://www.amazon.com/gp/product/B000WR3Z3A>`_ for getting data from your SD card.
Flashing Flashing
-------- --------
#. Once you have all these you will need to download an 0.3.0 image from https://images.start9.com. This is free for all existing users. Anyone who is running 0.2.x who compiled it themselves will need to either compile 0.3.0 themselves or download an 0.3.0 image. #. Once you have all these you will need to download the latest 0.3 image from `our github <https://github.com/start9labs/embassy-os/releases/latest>`_, scroll to the Assets section, and download `eos.tar.gz`.
#. Once you have the image, flash it on to the 32GB SD card - the new one, **NOT** the one currently in your Embassy! #. Once you have the image, flash it on to the 32GB SD card - the new one, **NOT** the one currently in your Embassy!
@@ -48,7 +48,7 @@ You may like to follow along with this video for clarity while migrating:
#. Next, remove the SD card that is in your Embassy and place it into the SD card adaptor, and then connect the adaptor to a USB port on your Embassy. #. Next, remove the SD card that is in your Embassy and place it into the SD card adaptor, and then connect the adaptor to a USB port on your Embassy.
#. Then take the new SD card with 0.3.0 on it and place it into the microSD card slot on your Embassy (not into the adaptor - that is for the old SD card!) #. Then take the new SD card with 0.3 on it and place it into the microSD card slot on your Embassy (not into the adaptor - that is for the old SD card!)
#. Next, plug the SSD into one of the USB 3.0 (blue) ports on your Embassy, then reconnect the Ethernet cable if not already connected. #. Next, plug the SSD into one of the USB 3.0 (blue) ports on your Embassy, then reconnect the Ethernet cable if not already connected.
@@ -61,40 +61,39 @@ Power Up
#. On your computer, open up a browser and go to http://embassy.local #. On your computer, open up a browser and go to http://embassy.local
#. You will be asked to enter your product key. This can be located on the bottom of your Embassy if you purchased, or in the repository folder if you built from source. #. Pick `Recover`
.. figure:: /_static/images/setup/migrate0.png .. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
:width: 60% :width: 60%
#. Next, pick `Restore From Backup`
#. Once entered, select "Recover" then select the microSD card - this will be labelled ``rootfs``. .. figure:: /_static/images/setup/screen1-restore_or_useexisting.jpg
.. figure:: /_static/images/setup/migrate1.png
:width: 60% :width: 60%
.. figure:: /_static/images/setup/migrate2.png #. You will be asked to select your old Embassy SD card - select rootfs
.. figure:: /_static/images/setup/screen3-restore_drive.jpg
:width: 60% :width: 60%
#. On the next page you will be asked to select a storage device - here you should select your SSD. #. On the next page you will be asked to select a storage device - here you should select your SSD.
.. figure:: /_static/images/setup/migrate3.png .. figure:: /_static/images/setup/screen4-select_storage.jpg
:width: 60% :width: 60%
.. note:: If it does not show up, please power down Embassy, unplug it, plug it back in, and boot Embassy again .. note:: If your SSD does not show up, unplug it from the USB port and plug it back in a different USB 3.0 (blue) port
#. If this drive is not empty, you will see a warning first, indicating all data will be overwritten. If you are happy to proceed, click "Continue".
.. figure:: /_static/images/setup/migrate4.png
:width: 60%
#. You will now need to make a password for your Embassy. It needs to be a strong password. This password protects your Embassy. It can be the same one that you used prior to migration, or a new one. Either way, make it strong, and make a backup of it. #. You will now need to make a password for your Embassy. It needs to be a strong password. This password protects your Embassy. It can be the same one that you used prior to migration, or a new one. Either way, make it strong, and make a backup of it.
#. Embassy will now recover all your data from your old Embassy and once finished, you will hear a _bep_, followed by a _chime_. .. figure:: /_static/images/setup/screen5-set_password.jpg
.. figure:: /_static/images/setup/migrate5.png
:width: 60% :width: 60%
#. Now you will be provided with both a Tor and LAN address with which you can access your Embassy. A file offered for download will contain this important information, which you should keep somewhere safe. It is also a good idea to make bookmarks on the devices that you will use to access your Embassy. #. Embassy will now recover all your data from your old Embassy and once finished, you will hear a _bep_, followed by a _chime_.
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
#. Now you will be provided with both a Tor and LAN address with which you can access your Embassy. A file download will contain this important information, which you should keep somewhere safe. It is also a good idea to make bookmarks on the devices that you will use to access your Embassy.
.. figure:: /_static/images/setup/migrate6.png .. figure:: /_static/images/setup/migrate6.png
:width: 60% :width: 60%

26
site/source/user-manual/upgrade-02/upgrade-kit.rst
View File

@@ -8,7 +8,7 @@ Setup with Upgrade Kit
:depth: 2 :depth: 2
:local: :local:
This guide will cover how to upgrade from EmbassyOS version 0.2.x to version 0.3.0. This guide will cover how to upgrade from EmbassyOS version 0.2.x to version 0.3.x.
.. note:: .. note::
If you purchased your own equipment please follow :ref:`this guide<upgrade-diy>`. If you purchased your own equipment please follow :ref:`this guide<upgrade-diy>`.
@@ -27,7 +27,7 @@ You may like to follow along with this video for clarity while migrating:
#. Next, remove the OLD SD card that is in your Embassy and place it into the SD card adaptor, and then connect the adaptor to any USB port on your Embassy. #. Next, remove the OLD SD card that is in your Embassy and place it into the SD card adaptor, and then connect the adaptor to any USB port on your Embassy.
#. Then take the NEW 32GB microSD card with 0.3.0 on it and place it into the microSD card slot on your Embassy. Be careful not to confuse the two microSD cards! #. Then take the NEW 32GB microSD card with 0.3 on it and place it into the microSD card slot on your Embassy. Be careful not to confuse the two microSD cards!
#. Next, plug the SSD into one of the USB 3.0 ports (the blue ones) on your Embassy, then reconnect the Ethernet cable if not already connected. #. Next, plug the SSD into one of the USB 3.0 ports (the blue ones) on your Embassy, then reconnect the Ethernet cable if not already connected.
@@ -40,28 +40,36 @@ Power Up
#. On your computer, open up a browser and go to http://embassy.local #. On your computer, open up a browser and go to http://embassy.local
#. Next, you will be asked to select your old Embassy SD card - select rootfs #. Pick `Recover`
.. figure:: /_static/images/setup/migrate2.png .. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
:width: 60% :width: 60%
#. You will now be prompted to enter your Product key #. Next, pick `Restore From Backup`
.. figure:: /_static/images/setup/migrate0.png .. figure:: /_static/images/setup/screen1-restore_or_useexisting.jpg
:width: 60%
#. You will be asked to select your old Embassy SD card - select rootfs
.. figure:: /_static/images/setup/screen3-restore_drive.jpg
:width: 60% :width: 60%
#. On the next page you will be asked to select a storage device - here you should select your SSD. #. On the next page you will be asked to select a storage device - here you should select your SSD.
.. figure:: /_static/images/setup/migrate3.png .. figure:: /_static/images/setup/screen4-select_storage.jpg
:width: 60% :width: 60%
.. note:: If it does not show up, please power down Embassy, unplug it, plug it back in, and boot Embassy again .. note:: If your SSD does not show up, unplug it from the USB port and plug it back in a different USB 3.0 (blue) port
#. You will now need to make a password for your Embassy. It needs to be a strong password. This password protects your Embassy. It can be the same one that you used prior to migration, or a new one. Either way, make it strong, and make a backup of it. #. You will now need to make a password for your Embassy. It needs to be a strong password. This password protects your Embassy. It can be the same one that you used prior to migration, or a new one. Either way, make it strong, and make a backup of it.
.. figure:: /_static/images/setup/screen5-set_password.jpg
:width: 60%
#. Embassy will now recover all your data from your old Embassy and once finished, you will hear a _bep_, followed by a _chime_. #. Embassy will now recover all your data from your old Embassy and once finished, you will hear a _bep_, followed by a _chime_.
.. figure:: /_static/images/setup/migrate5.png .. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60% :width: 60%
#. Now you will be provided with both a Tor and LAN address with which you can access your Embassy. A file download will contain this important information, which you should keep somewhere safe. It is also a good idea to make bookmarks on the devices that you will use to access your Embassy. #. Now you will be provided with both a Tor and LAN address with which you can access your Embassy. A file download will contain this important information, which you should keep somewhere safe. It is also a good idea to make bookmarks on the devices that you will use to access your Embassy.