Updating embassyOS¶

How to Update¶

1. When a new version of embassyOS is available, a badge will appear on the “Embassy” tab.

2. 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.

3. Read the release notes and click “Begin Update”.

4. While the new version of embassyOS is downloading, you may continue to use your device as usual.

5. Once the download is complete, you will be prompted to restart Embassy.

6. 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:

Do not unplug or otherwise power off the embassy during this period.

1. Next, you may be prompted to refresh the browser window.

Disabling Auto Check for Updates¶

By default, Embassy will automatically check for available updates. To disable this check, do the following:

1. Navigate to the Embassy > Preferences.

2. Click “Auto Check for Updates” and click “Disable”.

   Note

   With auth check for updates disabled, you will need to manually check for updates. This can be done by going to Embassy > Software Update.

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 by Re-flashing¶

1. Obtain the latest copy of embassyOS with your product key included, either by downloading or building from source.

2. Flash the downloaded image to your microSD card.

3. 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 downloaded 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.

4. On your computer, open up a browser and go to http://embassy.local

5. Select “Recover”

   

6. Select “Use Existing Drive”

   

7. Assuming you have you fully-intact embassyOS data drive plugged in, it will be automatically detected and begin the upgrade.

   
   This sound will play every ten seconds until the upgrade is done. Do not unplug or otherwise power off the embassy during this period.
   
   

8. Create a master password for your Embassy and click “Finish.”

   Warning

   Choose a strong master password. If you don’t wish to change your password from the previous version, just set it to the same thing it was before you began the upgrade. Write this password down. Store it somewhere safe. DO NOT LOSE IT.

   

9. Your Embassy is now on the new version and the old version’s data has been migrated to it! Continue to the section on Connecting to learn more about using your Embassy over Tor and LAN.

   Tip

   You will see the following screen and also be prompted to save your Embassy address and certificate info on your computer. We recommand you backup this html file somewhere safe so that you can reference it if you ever need to connect to your Embassy from a new computer.