Backups refactor, icons, more screens, misc edits (#81)

* Backups refactor, icons, more screens, misc edits

* Many fixes

* ya

* Backups refactor
This commit is contained in:
kn0wmad
2022-02-28 16:19:35 -07:00
committed by GitHub
parent 0053ead652
commit 1b0165295a
44 changed files with 455 additions and 255 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 192 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 139 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 168 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

After

Width:  |  Height:  |  Size: 68 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 14 KiB

View File

@@ -15,7 +15,7 @@ View frequently asked questions, troubleshoot common issues, or contact support.
.. topic-box::
:title: Common Issues
:link: common-issues
:icon: scylla-icon scylla-icon--monitoring
:icon: scylla-icon scylla-icon--knowledge-base
:class: large-5
:anchor: View
@@ -50,4 +50,4 @@ View frequently asked questions, troubleshoot common issues, or contact support.
common-issues
faq/index
contact
contact

View File

@@ -1,41 +1,38 @@
.. _backup-create:
.. _backup:
=============
Backup Create
=============
======
Backup
======
Backing up your Embassy is easy and secure. Backups are encrypted with your master password.
Backup Using LAN Shared Folder
------------------------------
.. warning:: Create frequent backups to avoid loss of data!
.. tip:: This is the recommended approach for creating backups.
Setup Device
------------
#. Follow instructions for creating a :ref:`LAN Shared Folder<cifs-setup>` on your laptop/desktop.
Select your platform for detailed instructions on how to create a LAN Shared Folder for creating backups (recommended). Otherwise, you may backup to a physical drive, attached in addition to your main Embassy SSD.
#. Go to *Embassy > Create Backup*.
.. toctree::
:maxdepth: 1
Linux LAN Shared Folder <backup-setup/backup-linux>
Mac LAN Shared Folder <backup-setup/backup-mac>
Windows LAN Shared Folder <backup-setup/backup-windows>
Synology LAN Shared Folder <backup-setup/backup-synology>
Physical Drive via Embassy <backup-setup/backup-physical>
.. _backup-create:
Create Backup
-------------
#. Go to *Embassy > Create Backup*
.. figure:: /_static/images/config/embassy_backup.png
:width: 60%
#. Next, click on "New Shared Folder".
.. figure:: /_static/images/config/embassy_backup0.png
:width: 60%
#. Fill in the following fields:
* Hostname - This is the hostname of the machine that your shared folder is located on
* Path - This is the directory path to the shared folder. If you configured Samba yourself (Linux), this is the "comment" (name of the share in your samba config file) and not the path.
* Username - This is the user on the remote machine that you used to create the shared directory
* Password - This is your user (from above) password
.. figure:: /_static/images/config/embassy_backup1.png
:width: 60%
#. Click "Save".
#. You will see a freshly created "cloud" backup location available, click it, then click "Create Backup".
#. You will see your previously created LAN Shared Folder backup location (or Physical Drive) available. Click it, then click "Create Backup".
.. figure:: /_static/images/config/embassy_backup2.png
:width: 60%
@@ -45,41 +42,7 @@ Backup Using LAN Shared Folder
.. figure:: /_static/images/config/embassy_backup3.png
:width: 60%
#. When the backup is complete you will receive a notification in the Notifications tab, and you will see the date and time of your most recent backup updated under "Backups" in the Embassy tab.
When the backup is complete, you will receive a notification. If successful, you will see the date and time of your most recent backup updated under "Backups" in the Embassy tab.
.. figure:: /_static/images/config/embassy_backup4.png
:width: 60%
Backup Using a Physical Drive
-----------------------------
.. tip:: You can backup to a physical drive using the recommended method above, rather than plugging the drive directly into the Embassy, which can cause problems.
.. caution:: If using the Raspberry Pi, you MUST use external power to attach a physical drive in order to prevent any data corruption due to power constraints.
#. Ensure your backup drive is properly formatted. The recommended format at this time is ``exFAT``. **Do not** use ``fat32``.
#. If your drive is self-powered, you can plug it directly into your Embassy blue USB 3.0 slot. If not, first plug the drive into a powered USB hub, then plug the hub into your Embassy. Then you may power it up.
#. Go to *Embassy > Create Backup*
.. figure:: /_static/images/config/physical-backup0.png
:width: 60%
#. Select your drive.
.. figure:: /_static/images/config/physical-backup1.png
:width: 60%
.. figure:: /_static/images/config/physical-backup2.png
:width: 60%
#. Enter your EmbassyOS master password.
.. figure:: /_static/images/config/physical-backup3.png
:width: 60%
After backup, you will receive a notice that the backup is complete, and you will see the latest backup date appear on the Embassy tab.
.. figure:: /_static/images/config/physical-backup4.png
:width: 60%

View File

@@ -1,8 +1,8 @@
.. _backup-restore:
==============
Backup Restore
==============
=======
Restore
=======
#. Go to *Embassy > Restore From Backup*.

View File

@@ -0,0 +1,124 @@
.. _backup-linux:
=======================
Linux LAN Shared Folder
=======================
Use this guide to setup a LAN Shared folder on your Linux machine, such that you may create encrypted, private backups of all your Embassy data.
Setup LAN Shared Folder
-----------------------
.. tabs::
.. group-tab:: Ubuntu
#. Install ``Samba`` if you have not already:
.. code-block::
sudo apt install samba
#. Add your user to samba, replacing ``YOUR-USER`` with your Linux username.
.. code-block:: bash
sudo smbpasswd -a YOUR-USER
Create a password and keep it somewhere safe, such as Vaultwarden
#. Right-click the folder that you want to backup to (or create a new one) and click "Properties"
.. figure:: /_static/images/cifs/cifs-lin0.png
:width: 60%
#. Select the "Local Network Share" tab
.. figure:: /_static/images/cifs/cifs-lin1.png
:width: 60%
#. Click "Share this folder"
.. figure:: /_static/images/cifs/cifs-lin2.png
:width: 60%
- You may rename the "Share", if you prefer - **remember this name**, you will need it later in your EmbassyUI
- (Optional) Create a description in the "Comment" section
#. Check the box for "Allow others to create and delete files in this folder", then click "Create Share"
.. figure:: /_static/images/cifs/cifs-lin3.png
:width: 60%
#. Click "Add Permissions Automatically"
.. figure:: /_static/images/cifs/cifs-lin4.png
:width: 60%
.. group-tab:: Other Linux
#. Install Samba if it is not already installed.
* ``sudo pacman -S samba`` For Arch
* ``sudo apt install samba`` For Debian
* ``sudo yum install samba`` For CentOS/Redhat
* ``sudo dnf install samba`` For Fedora
#. Create a directory to share or choose an existing one and make note of its location (path). For this example, it will be called ``test-backup`` and located at ``/home/user/test-backup``
#. Configure Samba, by adding the following to the end of the ``/etc/samba/smb.conf`` file:
.. code-block::
[test-share]
path = /home/user/test-backup
create mask = 0666
directory mask = 0777
read only = no
guest ok = no
Where:
- ``[test-share]`` is the *Share Name*, or title of the entry, and can be called anything you'd like
- ``path`` should be the path to the directory you created earlier
Copy the remainder of the entry exactly as it is
#. Open a terminal and enter the following command, replacing ``YOUR-USER`` with your Linux username:
.. code-block:: bash
sudo smbpasswd -a YOUR-USER
Create a password and keep it somewhere safe, such as Vaultwarden
Connect Embassy
---------------
#. Go to *Embassy > Create Backup*.
.. figure:: /_static/images/config/embassy_backup.png
:width: 60%
#. Click "Open".
.. figure:: /_static/images/config/embassy_backup0.png
:width: 60%
#. Fill in the following fields:
* Hostname - This is the hostname of the machine that your shared folder is located on
* Path - This is the "Share Name" (name of the share in your samba config) and **not** the full directory path
* Username - This is the user on the remote machine that you used to create the shared directory
* Password - This is your user (from above) password
.. figure:: /_static/images/config/embassy_backup1.png
:width: 60%
#. Click "Save".
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your Embassy data to your Linux machine or external drive!!

View File

@@ -0,0 +1,65 @@
.. _backup-mac:
=====================
Mac LAN Shared Folder
=====================
Use this guide to setup a LAN Shared Folder on your Mac (or attached drive), such that you may create encrypted, private backups of all your Embassy data.
Setup LAN Shared Folder
-----------------------
#. Either select or create a folder you would like to use to store your Embassy backups
#. Go to "System Preferences" and click "Sharing"
.. figure:: /_static/images/cifs/cifs-mac0.png
:width: 60%
#. Click file sharing
.. figure:: /_static/images/cifs/cifs-mac1.png
:width: 60%
#. Click the "+" under "Shared Folders" and add the folder you would like to back up to
.. figure:: /_static/images/cifs/cifs-mac2.png
:width: 60%
#. After selecting your folder, click "Options"
.. figure:: /_static/images/cifs/cifs-mac3.png
:width: 60%
#. Enable file sharing with "SMB" for the user you would like to use to authenticate and click "Done"
.. figure:: /_static/images/cifs/cifs-mac4.png
:width: 60%
You'll need the "Computer Name," and the name of the "Shared Folder" you chose above, as well as your Mac username and password for the following section
Connect Embassy
---------------
#. Go to *Embassy > Create Backup*.
.. figure:: /_static/images/config/embassy_backup.png
:width: 60%
#. Click "Open".
.. figure:: /_static/images/config/embassy_backup0.png
:width: 60%
#. Fill in the following fields:
* Hostname - This is the name of your Computer, as shown in the "Sharing" menu earlier
* Path - This is the *name of the shared folder* you are using and **not** the full directory path
* Username - This is the user on the remote machine that you used to create the shared directory
* Password - This is your user (from above) password
.. figure:: /_static/images/cifs/cifs-mac5.png
:width: 60%
#. Click "Save".
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your Embassy data to your Mac or external drive!!

View File

@@ -0,0 +1,38 @@
.. _backup-physical:
========================
Backup to Physical Drive
========================
.. warning:: Create frequent backups to avoid loss of data!
The recommended method of backup (including with external drives) is to setup a :ref:`LAN Shared Folder<backup-setup>` via your OS. However, you may use a powered external drive, or external drive via a powered USB 3.0 hub, connected directly to your Embassy if you prefer.
.. warning:: If you still choose to plug into your Embassy, this drive MUST have external power, or be connected via a powered USB hub in order to prevent any data corruption due to power constraints!
#. Ensure your backup drive is properly formatted. The recommended format at this time is ``exFAT``. **Do not** use ``fat32``.
#. If your drive is self-powered, you can plug it directly into your Embassy blue USB 3.0 slot. If not, first plug the drive into a powered USB hub, then plug the hub into your Embassy. Then you may power it up.
#. Go to *Embassy > Create Backup*
.. figure:: /_static/images/config/physical-backup0.png
:width: 60%
#. Select your drive.
.. figure:: /_static/images/config/physical-backup1.png
:width: 60%
.. figure:: /_static/images/config/physical-backup2.png
:width: 60%
#. Enter your EmbassyOS master password.
.. figure:: /_static/images/config/physical-backup3.png
:width: 60%
When the backup is complete, you will receive a notification. If successful, you will see the date and time of your most recent backup updated under "Backups" in the Embassy tab.
.. figure:: /_static/images/config/physical-backup4.png
:width: 60%

View File

@@ -1,11 +1,14 @@
.. _cifs-synology:
========================================
Creating a LAN Shared Folder on Synology
========================================
.. _backup-synology:
==========================
Synology LAN Shared Folder
==========================
.. note:: This guide was created by a Start9 community member. This is not yet officially supported. Please report any feedback that may help improve the process.
Setup LAN Shared Folder
-----------------------
#. In Synology UI, go to *Control Panel > Shared Folder* and select the folder you want to use. Click "Permissions" and make sure you have read/write permissions for the user you're going to be logging in as. Click "Save".
#. Back in Synology UI, go to *Control Panel > File Services > SMB* and click the SMB drop down button if it isn't already selected. Ensure that "Enable SMB service" is checked.
@@ -14,4 +17,31 @@ Creating a LAN Shared Folder on Synology
#. In the same dropdown, under "Note" will be "PC (Windows Explorer): \". This DeviceAddressName is the "Hostname" within the Embassy New Shared Folder dialog, and note that it is case sensitive and that the \ have been removed.
#. Back in Synonogy UI, click "File Station" and navigate so that you can see the the desired destination folder. Right click the folder, then *Properties > General*. Next to "Location" will be a folder location of the format ///, the / portion (so without the volume label) is the "Path" within the Embassy New Shared Folder dialog.
#. Back in Synonogy UI, click "File Station" and navigate so that you can see the the desired destination folder. Right click the folder, then *Properties > General*. Next to "Location" will be a folder location of the format ///, the / portion (so without the volume label) is the "Path" within the Embassy New Shared Folder dialog.
Connect Embassy
---------------
#. Go to *Embassy > Create Backup*.
.. figure:: /_static/images/config/embassy_backup.png
:width: 60%
#. Click "Open".
.. figure:: /_static/images/config/embassy_backup0.png
:width: 60%
#. Fill in the following fields:
* Hostname - This is the hostname of the machine that your shared folder is located on
* Path - This is the "Share Name" (name of the share in your samba config) and **not** the full directory path
* Username - This is the user on the remote machine that you used to create the shared directory
* Password - This is your user (from above) password
.. figure:: /_static/images/config/embassy_backup1.png
:width: 60%
#. Click "Save".
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your Embassy data to your Linux machine or external drive!!

View File

@@ -0,0 +1,66 @@
.. _backup-windows:
=========================
Windows LAN Shared Folder
=========================
Use this guide to setup a LAN Shared Folder on your Windows machine (or attached drive), such that you may create encrypted, private backups of all your Embassy data.
Setup LAN Shared Folder
-----------------------
#. Create a folder, or select an existing one. Right-click the folder and select "Properties"
.. figure:: /_static/images/cifs/cifs-win0.png
:width: 60%
#. Click the "Sharing" tab...
.. figure:: /_static/images/cifs/cifs-win1.png
:width: 60%
then click "Share"
.. figure:: /_static/images/cifs/cifs-win2.png
:width: 60%
#. Select a user you want to use for login and click "Share"
.. figure:: /_static/images/cifs/cifs-win3.png
:width: 60%
.. note::
If you get the following dialogue box, you have designated your network "Public." You may wish to change to "Private" if this is your home network. Otherwise you may turn on network sharing for public networks.
.. figure:: /_static/images/cifs/cifs-win4.png
:width: 60%
#. You'll need the path from this screen (shown in gray under the "SharedFolder" folder), for the final step below.
.. figure:: /_static/images/cifs/cifs-win5.png
:width: 60%
Connect Embassy
---------------
#. Return to your EmbassyUI, and go to *Embassy > Create Backup*
.. figure:: /_static/images/config/embassy_backup.png
:width: 60%
#. Click "Open" to set up a new connection to your Shared Folder
.. figure:: /_static/images/config/embassy_backup0.png
:width: 60%
#. Fill out the following fields as shown below:
.. figure:: /_static/images/cifs/cifs-win6.png
:width: 60%
- For "Hostname" - Enter your Windows computer name (this is shown after a ``\\`` in Windows)
- For "Path" - Enter the "Path" that is shown after the ``HOSTNAME\`` in Windows
- Enter your Windows username and password in the "User" and "Password" fields
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your Embassy data to your Windows machine or external drive!!

View File

@@ -1,62 +0,0 @@
.. _cifs-linux:
=====================================
Creating a LAN Shared Folder on Linux
=====================================
.. tabs::
.. group-tab:: Ubuntu
#. Open the file manager
#. Right-click the folder that you want to backup to (or create a new one) and click ``Local Network Share`` from the menu.
#. In the resulting window, select the check box for ``Share this folder`` and then check the box for ``Allow others to create and delete files in this folder``.
#. Create a description in the ``Comment`` section - remember this, you will need it later
#. Click ``Create Share``
#. Click ``Add the permissions automatically``
#. That's it! Now you can make encrypted backups to your own, private "cloud" by using the :ref:`Backup flow<backups>` in the Embassy UI.
.. group-tab:: Other Linux
#. Install Samba if it is not already installed.
* ``sudo pacman -S samba`` For Arch
* ``sudo apt install samba`` For Debian
* ``sudo yum install samba`` For CentOS/Redhat
* ``sudo dnf install samba`` For Fedora
#. Create a directory to share or choose an existing one and make note of its location (path). For this example, it will be called ``test-backup`` and located at ``/home/embassy/test-backup``
#. Configure Samba, by adding the following to the end of the ``/etc/samba/smb.conf`` file:
.. code-block::
[testing]
path = /home/embassy/test-backup
create mask = 0666
directory mask = 0777
read only = no
guest ok = no
Where:
- ``[testing]`` is the *comment*, or title of the entry, and can be called anything you'd like
- the ``path`` should be the path to the directory you created earlier
- copy the remainder of the entry exactly as it is
#. Add your user to Samba and "own" the directory if you do not already, then change the password
.. code-block::
smbpassword -a YOUR-USER
smbpassword
After creating your password, you can return to your Embassy UI to complete setup and :ref:`Create the Backup <backup-create>`.

View File

@@ -1,23 +0,0 @@
.. _cifs-mac:
===================================
Creating a LAN Shared Folder on Mac
===================================
#. Go to system settings
#. Click sharing
#. Click file sharing
#. Click the + under shared folders
#. Add a folder and click options
#. Enable Windows file sharing for the user you would like to use to authenticate and click Done
#. Enter the name of your macbook, as shown in the computer name field at the top of the sharing page into the hostname field in embassy ui
#. Enter the name of the folder as shown in the shared folders section as the path
#. Enter your macbook username and password for the user that you enabled windows file sharing for

View File

@@ -1,25 +0,0 @@
.. _cifs-windows:
=======================================
Creating a LAN Shared Folder on Windows
=======================================
#. Create a folder
#. Right click the folder
#. Select "properties"
#. Click the share tab
#. Click share...
#. Select a user you want to use for login, or select everyone and click share
#. Enter your computer name into the hostname field in embassy ui (the name is shown after a \\ in the windows ui)
#. Enter the path that is shown after the hostname in the windows ui into the path field
#. Enter your username for the windows computer
#. Enter the password for the windows computer

View File

@@ -1,15 +0,0 @@
.. _cifs-setup:
============================
Creating a LAN Shared Folder
============================
Click your platform for detailed instructions on how to create a LAN Shared Folder for creating backups.
.. toctree::
:maxdepth: 2
Linux <cifs-linux>
Mac <cifs-mac>
Windows <cifs-windows>
Synonogy <cifs-synology>

View File

@@ -4,7 +4,7 @@
Backups
=======
In addition to safekeeping of a good master password, maintaining good backups are among the few major responsibilities required to keep the benefits and freedom that come with self-hosting.
In addition to the safe-keeping of a good master password, maintaining good backups is the major responsibility required to keep the benefits and freedom that come with self-hosting.
.. raw:: html
@@ -15,29 +15,20 @@ In addition to safekeeping of a good master password, maintaining good backups a
.. topic-box::
:title: Create Backup
:link: backup-create
:icon: scylla-icon scylla-icon--memory-management
:icon: scylla-icon scylla-icon--cloud
:class: large-5
:anchor: View
:anchor: Backup
Create an encrypted backup of Embassy.
Create an encrypted backup of your Embassy data.
.. topic-box::
:title: Restore from Backup
:title: Restore From Backup
:link: backup-restore
:icon: scylla-icon scylla-icon--comparison
:icon: scylla-icon scylla-icon--live-test
:class: large-5
:anchor: View
:anchor: Restore
Restore Embassy from a previous backup.
.. topic-box::
:title: LAN Shared Folder Setup
:link: cifs-setup/index
:icon: scylla-icon scylla-icon--networking
:class: large-5
:anchor: Setup
Setup a Shared Network Folder on a desktop, laptop, or drive on your local network.
Restore your Embassy data from a previous backup.
.. raw:: html
@@ -49,4 +40,3 @@ In addition to safekeeping of a good master password, maintaining good backups a
backup-create
backup-restore
cifs-setup/index

View File

@@ -22,7 +22,7 @@ Connecting
.. topic-box::
:title: Connecting Over Tor
:link: connecting-tor
:icon: scylla-icon scylla-icon--tor
:icon: scylla-icon scylla-icon--networking
:class: large-5
:anchor: Setup

View File

@@ -10,4 +10,4 @@ To optimize your device for use with your Embassy, it is recommended to complete
* :ref:`tor-linux` - Run Tor natively (in the background) on your Linux machine. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
* :ref:`torff-linux` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers.
* :ref:`cifs-linux` - Configure a LAN Shared Folder on your Linux machine (or an external drive plugged into your Linux Machine) in order to use it for Embassy backups.
* :ref:`backup-linux` - Configure a LAN Shared Folder on your Linux machine (or an attached external drive) for Embassy backups.

View File

@@ -11,4 +11,4 @@ To optimize your device for use with your Embassy, it is recommended to complete
* :ref:`lan-mac` - Trust your Embassy's Root Certificate Authority in order to securely connect over LAN.
* :ref:`tor-mac` - Run Tor natively (in the background) on your Mac. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
* :ref:`torff-mac` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers.
* :ref:`cifs-mac` - Configure a LAN Shared Folder on your Mac (or an external drive plugged into your Mac in order to use it for Embassy backups.
* :ref:`backup-mac` - Configure a LAN Shared Folder on your Mac (or an attached external drive) for Embassy backups.

View File

@@ -11,4 +11,4 @@ To optimize your device for use with your Embassy, it is recommended to complete
* :ref:`lan-windows` - Trust your Embassy's Root Certificate Authority in order to securely connect over LAN.
* :ref:`tor-windows` - Run Tor natively (in the background) on your Windows computer. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
* :ref:`torff-windows` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers.
* :ref:`cifs-windows` - Configure a LAN Shared Folder on your Windows computer (or an external drive plugged into your Windows computer) in order to use it for Embassy backups.
* :ref:`backup-windows` - Configure a LAN Shared Folder on your Windows computer (or an attached external drive) for Embassy backups.

View File

@@ -9,7 +9,7 @@ These guides will help you to setup external tools to connect or interact with s
.. toctree::
:maxdepth: 1
vaultwarden
matrix
bitcoin
lightning
matrix
vaultwarden

View File

@@ -20,25 +20,20 @@ Hardware Requirements
#. `SD card adapter <https://www.amazon.com/gp/product/B000WR3Z3A>`_ for getting data from your SD card.
.. _migrate-02-instructions:
Instructions
------------
Backing up
..........
----------
.. caution:: It is prudent to back up your Embassy before migrating in case something doesn't work correctly, or there is an accident
If you're unsure how to do this - please follow `this <https://youtube.com/watch?v=_QJXgnE90ko>`_ guide.
.. youtube:: _QJXgnE90ko
.. youtube:: ySd8uFJTbvQ
:width: 100%
With your Embassy safely backed up, it's time to proceed with the migration.
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 purchase an 0.3.0 image.
@@ -49,7 +44,11 @@ Flashing
.. _migrate-02-migrate:
Migrate Data
............
------------
You may like to follow along with this video for clarity while migrating:
.. youtube:: 2yXgkni95mg
:width: 100%
#. Begin by going into your Embassy, stopping all running services, and shutting down the device in the Embassy tab.
@@ -64,7 +63,7 @@ Migrate Data
#. 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 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.
@@ -112,4 +111,6 @@ Power Up
#. 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.
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.
.. note:: For those recovering Bitwarden - it is now called Vaultwarden.

View File

@@ -9,13 +9,8 @@ This guide will cover how to upgrade from EmbassyOS version 0.2.x to version 0.3
.. note::
If you purchased your own equipment please follow :ref:`this guide<upgrade-diy>`.
.. _migrate-02-instructions:
Instructions
------------
Backing up
..........
----------
.. caution:: It is prudent to back up your Embassy before migrating in case something doesn't work correctly, or there is an accident
@@ -27,7 +22,12 @@ If you're unsure how to do this - please follow `this <https://youtube.com/watch
With your Embassy safely backed up, it's time to proceed with the migration.
Migrating Data
..............
--------------
You may like to follow along with this video for clarity while migrating:
.. youtube:: 2yXgkni95mg
:width: 100%
#. Begin by going into your Embassy, stopping all running services, and shutting down the device in the Embassy tab.
@@ -42,11 +42,11 @@ Migrating Data
#. 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
#. On your computer, open up a browser and go to https://embassy.local
#. You will be prompted that your drive and your SD card reader needed to be reconfigured and asked to unplug them and replug them into your Embassy. Please do this and hit refresh.
@@ -78,4 +78,6 @@ Power Up
#. 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.
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.
.. note:: For those recovering Bitwarden - it is now called Vaultwarden.