mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 20:14:50 +00:00
one-pro migration (#238)
* one-pro migration * add warning * fix link * typo * typo * imporve phrasing * add beethoven sound * dave's suggestions
This commit is contained in:
BitcoinMechanic
70
site/source/user-manual/upgrade-hardware/index.rst
Normal file
70
site/source/user-manual/upgrade-hardware/index.rst
Normal file
@@ -0,0 +1,70 @@
|
||||
.. _upgrade-hardware:
|
||||
|
||||
================
|
||||
Upgrade Hardware
|
||||
================
|
||||
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Upgrade from Embassy One to Embassy Pro
|
||||
:link: upgrade-pro
|
||||
:icon: scylla-icon scylla-icon--enterprise
|
||||
:class: large-5
|
||||
:anchor: Upgrade
|
||||
|
||||
This is for migrating from an Embassy One to an Embassy Pro
|
||||
|
||||
.. topic-box::
|
||||
:title: Upgrade to all-in-one NASPi case
|
||||
:link: naspi-upgrade
|
||||
:icon: scylla-icon scylla-icon--home
|
||||
:class: large-5
|
||||
:anchor: Upgrade
|
||||
|
||||
This is for if you purchased a NASPi upgrade kit from us
|
||||
|
||||
.. topic-box::
|
||||
:title: Upgrade Kit v0.2 - v0.3
|
||||
:link: upgrade-kit
|
||||
:icon: scylla-icon scylla-icon--getting-started
|
||||
:class: large-5
|
||||
:anchor: Upgrade
|
||||
|
||||
This is for if you purchased an upgrade kit from us to migrate from embassyOS v0.2.x to v0.3+
|
||||
|
||||
.. topic-box::
|
||||
:title: Bring your own equipment
|
||||
:link: upgrade-diy
|
||||
:icon: scylla-icon scylla-icon--resource-center
|
||||
:class: large-5
|
||||
:anchor: Upgrade
|
||||
|
||||
This is for if you purchased your own hardware to migrate from embassyOS v0.2.x to v0.3+
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
.. raw:: html
|
||||
|
||||
</div></div>
|
||||
|
||||
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
Pro upgrade <upgrade-pro>
|
||||
NASPi upgrade <naspi-upgrade>
|
||||
Upgrade Kit <upgrade-kit>
|
||||
DIY Hardware <upgrade-diy>
|
||||
|
||||
|
||||
10
site/source/user-manual/upgrade-hardware/naspi-upgrade.rst
Normal file
10
site/source/user-manual/upgrade-hardware/naspi-upgrade.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
.. _naspi-upgrade:
|
||||
|
||||
======================================
|
||||
Upgrading from an External Drive Setup
|
||||
======================================
|
||||
|
||||
If you already have an Embassy with an external drive, you can follow along from the `written guide appendix <https://community.start9.com/t/diy-embassy-one-geekworm-naspi-case/49>`_ and/or check out the video below:
|
||||
|
||||
.. youtube:: 355BENA42s8
|
||||
:width: 100%
|
||||
156
site/source/user-manual/upgrade-hardware/upgrade-diy.rst
Normal file
156
site/source/user-manual/upgrade-hardware/upgrade-diy.rst
Normal file
@@ -0,0 +1,156 @@
|
||||
.. _upgrade-diy:
|
||||
|
||||
=======================
|
||||
Using your own hardware
|
||||
=======================
|
||||
|
||||
.. contents::
|
||||
: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.
|
||||
|
||||
Hardware Requirements
|
||||
---------------------
|
||||
|
||||
.. note::
|
||||
If you purchased the `upgrade kit <https://store.start9.com/collections/embassy/products/upgrade-kit>`_ from Start9, you should follow :ref:`this guide<upgrade-kit>`.
|
||||
|
||||
#. `32GB microSD card <https://www.amazon.com/dp/B07P14QHB7/>`_
|
||||
|
||||
#. `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/B01LY97QE8>`_ for your drive.
|
||||
|
||||
#. `SD card adapter <https://www.amazon.com/gp/product/B000WR3Z3A>`_ for getting data from your SD card.
|
||||
|
||||
Downloading
|
||||
-----------
|
||||
|
||||
#. 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`` for Linux/Mac or ``eos.zip`` for Windows.
|
||||
|
||||
Extracting the image
|
||||
--------------------
|
||||
|
||||
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
|
||||
|
||||
Flashing
|
||||
--------
|
||||
|
||||
#. Once you have the image, flash it on to the 32GB SD card - the new one, **NOT** the one currently in your Embassy!
|
||||
|
||||
.. tip:: The flashing software we recommend is `Balena Etcher <https://www.balena.io/etcher/>`_
|
||||
|
||||
.. _migrate-02-migrate:
|
||||
|
||||
Migrate Data
|
||||
------------
|
||||
|
||||
You may like to follow along with this video for clarity while migrating:
|
||||
.. youtube:: ySd8uFJTbvQ
|
||||
:width: 100%
|
||||
|
||||
#. Begin by going into your Embassy, stopping all running services, and shutting down the device in the Embassy tab.
|
||||
|
||||
#. Once you've heard the power-off sound, wait a few more seconds and then safely unplug the 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 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.
|
||||
|
||||
#. Now the power cable can be connected and the Embassy powered up.
|
||||
|
||||
Power Up
|
||||
--------
|
||||
|
||||
#. Embassy will power up and then initialize, a process of less than 5 minutes if you downloaded the 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.
|
||||
|
||||
#. On your computer, open up a browser and go to http://embassy.local
|
||||
|
||||
#. Pick `Recover`
|
||||
|
||||
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Next, pick `Restore From Backup`
|
||||
|
||||
.. 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%
|
||||
|
||||
#. On the next page you will be asked to select a storage device - here you should select your SSD.
|
||||
|
||||
.. 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 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.
|
||||
|
||||
.. 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_.
|
||||
|
||||
.. 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/screen7-upgrade_complete.jpg
|
||||
:width: 60%
|
||||
|
||||
#. To use LAN safely, the SSL certificate will need to be added to whatever device you are using to access. This can be downloaded by clicking on "Download root CA" and installed by following the :ref:`instructions<connecting-lan>`.
|
||||
|
||||
#. You can now log in to your Embassy via Tor or LAN, and you will be given the option of recovering your data on a service-by-service basis.
|
||||
|
||||
IMPORTANT NOTES
|
||||
---------------
|
||||
- You may remove your 0.2.x SD Card once you reach the success page. It is highly recommended to keep this card in a safe place for a few weeks to ensure your migrated Embassy is working smoothly. After this you may wipe and repurpose the card however you wish.
|
||||
|
||||
- Do NOT use the old 0.2.x card again, unless instructed by a Start9 Support Tech, especially if you have funds on the Lightning Network, as it can lead to loss of funds!
|
||||
|
||||
- Please note that some services, such as LND, will have new Tor interfaces, and so you will need to add your new credentials to your integrations, such as Zap and Zeus wallets.
|
||||
|
||||
- For those recovering Bitwarden - it is now called Vaultwarden.
|
||||
|
||||
- For those recovering Bitcoin and changing to a full archival node: You will need to "Disable Pruning" in the config, and run the "Reindex Blockchain" Action, then restart the service upon completion of the sync.
|
||||
94
site/source/user-manual/upgrade-hardware/upgrade-kit.rst
Normal file
94
site/source/user-manual/upgrade-hardware/upgrade-kit.rst
Normal file
@@ -0,0 +1,94 @@
|
||||
.. _upgrade-kit:
|
||||
|
||||
======================
|
||||
Setup with Upgrade Kit
|
||||
======================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
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>`.
|
||||
|
||||
Migrating Data
|
||||
--------------
|
||||
|
||||
You may like to follow along with this video for clarity while migrating:
|
||||
.. youtube:: A5Z7aX3x5eU
|
||||
:width: 100%
|
||||
|
||||
|
||||
#. Begin by going into your Embassy, stopping all running services, and shutting down the device in the Embassy tab.
|
||||
|
||||
#. Once you've heard the power-off sound, wait a few more seconds and then safely unplug the 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 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.
|
||||
|
||||
#. Now the power cable can be connected and the Embassy powered up.
|
||||
|
||||
Power Up
|
||||
--------
|
||||
|
||||
#. Embassy will power up and then initialize, a process of less than 5 minutes. 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
|
||||
|
||||
#. Pick `Recover`
|
||||
|
||||
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Next, pick `Restore From Backup`
|
||||
|
||||
.. 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%
|
||||
|
||||
#. On the next page you will be asked to select a storage device - here you should select your SSD.
|
||||
|
||||
.. 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 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.
|
||||
|
||||
.. 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_.
|
||||
|
||||
.. 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/screen7-upgrade_complete.jpg
|
||||
:width: 60%
|
||||
|
||||
#. To use LAN safely, the SSL certificate will need to be added to whatever device you are using to access. This can be downloaded by clicking on "Download root CA" and installed by following the :ref:`instructions<connecting-lan>`.
|
||||
|
||||
#. You can now log in to your Embassy via Tor or LAN, and you will be given the option of recovering your data on a service-by-service basis.
|
||||
|
||||
IMPORTANT NOTES
|
||||
---------------
|
||||
- You may remove your 0.2.x SD Card once you reach the success page. It is highly recommended to keep this card in a safe place for a few weeks to ensure your migrated Embassy is working smoothly. After this you may wipe and repurpose the card however you wish.
|
||||
|
||||
- Do NOT use the old 0.2.x card again, unless instructed by a Start9 Support Tech, especially if you have funds on the Lightning Network, as it can lead to loss of funds!
|
||||
|
||||
- Please note that some services, such as LND, will have new Tor interfaces, and so you will need to add your new credentials to your integrations, such as Zap and Zeus wallets.
|
||||
|
||||
- For those recovering Bitwarden - it is now called Vaultwarden.
|
||||
|
||||
- For those recovering Bitcoin and changing to a full archival node: You will need to "Disable Pruning" in the config, and run the "Reindex Blockchain" Action, then restart the service upon completion of the sync.
|
||||
165
site/source/user-manual/upgrade-hardware/upgrade-pro.rst
Normal file
165
site/source/user-manual/upgrade-hardware/upgrade-pro.rst
Normal file
@@ -0,0 +1,165 @@
|
||||
.. _upgrade-pro:
|
||||
|
||||
=================================================
|
||||
Migrating From Embassy One to Embassy Pro (NASPi)
|
||||
=================================================
|
||||
|
||||
This is for Embassy One users upgrading from a NASPi (pictured below). If you're using a Samsung T5/T7 please go :ref:`here <samsung-drives>`.
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/embassy-one.png
|
||||
:width: 30%
|
||||
|
||||
You will need a high quality USB-A to USB-A cable like `this <https://www.amazon.com/UGREEN-Transfer-Enclosures-Printers-Cameras/dp/B00P0E3954/?th=1>`_. Or a USB-A to USB-C cable like `this <https://www.amazon.com/AmazonBasics-Type-C-USB-Male-Cable/dp/B01GGKYKQM/?th=1>`_.
|
||||
|
||||
#. Shutdown your Embassy One
|
||||
|
||||
.. figure:: /_static/images/walkthrough/shutdown.png
|
||||
:width: 60%
|
||||
|
||||
#. Listen out for the shutdown sounds, then after few more seconds, disconnect the power.
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/SHUTDOWN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* Shutdown sound
|
||||
|
||||
#. Now disconnect the USB adapter found here:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/naspi-jameson-loop2.png
|
||||
:width: 60%
|
||||
|
||||
#. Connect the USB cable to the lowest blue USB port like this:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/usb-into-naspi-edited.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Now connect the Ethernet cable and then the power to your Embassy Pro
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/pro-all.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Head to http://embassy.local on any device on the same LAN
|
||||
|
||||
#. Select "Recover"
|
||||
|
||||
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.png
|
||||
:width: 60%
|
||||
|
||||
#. Select "Transfer"
|
||||
|
||||
.. figure:: /_static/images/setup/transfer.png
|
||||
:width: 60%
|
||||
|
||||
#. Now connect the other end of the USB cable to either an Embassy Pro USB-3 port or the USB-C port:
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/pro-all-highlighted.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Connect the power to the NASPi - you will hear this sound and can ignore it:
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/BEETHOVEN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* Beethoven's 5th
|
||||
|
||||
#. Select the drive inside the NASPi (you may need to hit refresh):
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-from.png
|
||||
:width: 60%
|
||||
|
||||
#. Select the drive inside the Embassy Pro that you are migrating *to* (this will erase any data on this drive):
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-to.png
|
||||
:width: 60%
|
||||
|
||||
#. You will be asked to create a password. It can be the same as it was previously:
|
||||
|
||||
.. figure:: /_static/images/setup/screen5-set_password.png
|
||||
:width: 60%
|
||||
|
||||
#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours:
|
||||
|
||||
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
|
||||
:width: 60%
|
||||
|
||||
#. You are now ready to proceed and use your Embassy Pro - it will have the same addresses and root certificate as it did before migrating.
|
||||
|
||||
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
|
||||
:width: 60%
|
||||
|
||||
.. warning:: Do not unders any circumstances reassemble your Embassy One without wiping the SD card first and wiping the SSD during initial setup! If you do not this will cause serious problems! If you have lightning channels you could lose all your funds!
|
||||
|
||||
.. _samsung-drives:
|
||||
|
||||
Samsung T5/T7/alternative drives
|
||||
================================
|
||||
|
||||
#. Shutdown your Embassy One
|
||||
|
||||
.. figure:: /_static/images/walkthrough/shutdown.png
|
||||
:width: 60%
|
||||
|
||||
#. Listen out for the shutdown sounds, then after few more seconds, disconnect the power.
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/SHUTDOWN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* Shutdown sound
|
||||
|
||||
#. Now connect the Ethernet cable and then the power to your Embassy Pro
|
||||
|
||||
.. figure:: /_static/images/hardware-pics/pro-all.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Head to http://embassy.local on any device on the same LAN
|
||||
|
||||
#. Select "Recover"
|
||||
|
||||
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.png
|
||||
:width: 60%
|
||||
|
||||
#. Select "Transfer"
|
||||
|
||||
.. figure:: /_static/images/setup/transfer.png
|
||||
:width: 60%
|
||||
|
||||
#. Now connect your Samsung T5/T7/alternative drive to any USB-3 or USB-C port on your Embassy Pro
|
||||
|
||||
#. Select this drive (you may need to hit refresh):
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-from.png
|
||||
:width: 60%
|
||||
|
||||
#. Select the drive inside the Embassy Pro that you are migrating *to* (this will erase any data on this drive):
|
||||
|
||||
.. figure:: /_static/images/setup/transfer-to.png
|
||||
:width: 60%
|
||||
|
||||
#. You will be asked to create a password. It can be the same as it was previously:
|
||||
|
||||
.. figure:: /_static/images/setup/screen5-set_password.png
|
||||
:width: 60%
|
||||
|
||||
#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours:
|
||||
|
||||
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
|
||||
:width: 60%
|
||||
|
||||
#. You are now ready to proceed and use your Embassy Pro - it will have the same addresses and root certificate as it did before migrating.
|
||||
|
||||
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
|
||||
:width: 60%
|
||||
|
||||
.. warning:: Do not unders any circumstances reassemble your Embassy One without wiping the SD card first and wiping the SSD during initial setup! If you do not this will cause serious problems! If you have lightning channels you could lose all your funds!
|
||||
Reference in New Issue
Block a user