Caution
You are not reading the latest stable version of this documentation. If you want up-to-date information, please have a look at master.
This guide will cover how to upgrade from embassyOS version 0.2.x to version 0.3.x with your own equipment.
Note
If you purchased the upgrade kit from Start9, you should follow this guide.
1TB solid state drive minimum, 2TB+ recommended.
SD card adapter for getting data from your SD card.
Once you have all these you will need to download the latest 0.3 image from our github, scroll to the Assets section, and download eos.tar.gz
for Linux/Mac or eos.zip
for Windows.
Download the eos.tar.gz
file and open a terminal in the directory you save it to
Extract with:
tar -xzvf eos.tar.gz
(Optional, but recommended) Verify the checksum against the one listed on GitHub:
sha256sum eos.img
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:
openssl dgst -sha256 eos.img
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:
Get-FileHash eos.img
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
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.
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
Next, pick Restore From Backup
You will be asked to select your old Embassy SD card - select rootfs
On the next page you will be asked to select a storage device - here you should select your SSD.
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.
Embassy will now recover all your data from your old Embassy and once finished, you will hear a _bep_, followed by a _chime_.
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.
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 instructions.
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.
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.