mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-04-01 21:13:10 +00:00
Edits for release (#77)
* General edits, layout changes * Backup/restore, misc edits * Alt Markets, cifs/dg updates * Migration screens * Recover 03 drive * update some dev doc titles Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
This commit is contained in:
kn0wmad
@@ -4,20 +4,14 @@
|
||||
Alt Marketplaces
|
||||
================
|
||||
|
||||
EmbassyOS supports accessing alternative marketplaces.
|
||||
It is critical to Start9's mission that Start9 NOT be a central point of failure. The Marketplace is a critical piece of infrastructure and therefore EmbassyOS supports accessing alternative marketplaces.
|
||||
|
||||
.. caution:: Start9 is not responsible for issues encountered when downloading services from alternative marketplaces, and cannot provide support for services that are not from our offical marketplace. Here be dragons!!
|
||||
|
||||
After SSH-ing into the Embassy, run the following command, replacing ``<url>`` with your desired marketplace URL:
|
||||
.. note:: Currently this change will allow you to download services from a Marketplace of your choice. At this time, EmbassyOS updates on alternative Marketplaces are not supported.
|
||||
|
||||
.. code-block:: bash
|
||||
#. Go to Embassy -> Marketplace Settings
|
||||
|
||||
embassy-cli server set-marketplace <url>
|
||||
|
||||
or to only change the marketplace for fetching packages, but not os updates:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
embassy-cli package set-marketplace <url>
|
||||
#. Click "Add Alternative Marketplace" and enter the URL of your desired Marketplace. You may connect immediately, or save for use later
|
||||
|
||||
.. note:: Make sure you have the URL **EXACTLY CORRECT.** If you do not, your Embassy may crash. In this case, just reboot the device and try again.
|
||||
|
||||
@@ -9,8 +9,8 @@ There are 2 options for backing up your Embassy and service data:
|
||||
1. Use a Shared Network Folder (recommended) on another device that connected to the same network as your Embassy, such as a laptop/desktop or external drive that is plugged into your laptop/desktop.
|
||||
2. Use a physical drive, which must be externally powered or plugged into a powered USB hub.
|
||||
|
||||
Shared Network Folder
|
||||
---------------------
|
||||
LAN Backups
|
||||
-----------
|
||||
|
||||
This is the recommended approach for creating backups.
|
||||
|
||||
@@ -29,7 +29,7 @@ This is the recommended approach for creating backups.
|
||||
#. Fill in the following fields:
|
||||
|
||||
* Hostname - This is the hostname of the machine that your folder or drive is located on
|
||||
* Path - This is the directory path to the shared folder. If you setup Samba yourself (Linux), this may be the name of the share in your samba config file and not the path.
|
||||
* 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
|
||||
|
||||
@@ -53,11 +53,34 @@ This is the recommended approach for creating backups.
|
||||
.. figure:: /_static/images/config/embassy_backup4.png
|
||||
:width: 60%
|
||||
|
||||
Physical Drive
|
||||
--------------
|
||||
Physical Backups
|
||||
----------------
|
||||
|
||||
#. If your drive is self-powered, you can plug it directly into your Embassy USB 3.0 (blue) slot. If not, first plug the drive into a powered USB hub, then plug the hub into your Embassy USB 3.0 slot.
|
||||
You may use a drive by attaching to Embassy directly if you prefer. The recommended format at this time is ``exFAT``.
|
||||
|
||||
#. Go to ``Embassy`` -> ``Create Backup``
|
||||
.. 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.
|
||||
|
||||
#. Select the drive
|
||||
#. First, go to ``Embassy`` -> ``Create Backup``
|
||||
|
||||
.. figure:: /_static/images/config/physical-backup0.png
|
||||
:width: 60%
|
||||
|
||||
#. Plug drive USB cable into Embassy. If your drive is self-powered, you can plug it directly into your Embassy USB 3.0 (blue) slot. If not, first plug the drive into a powered USB hub, then plug the hub into your Embassy USB 3.0 slot. Then you may power it up.
|
||||
|
||||
#. Press ``Refresh`` in the top-right corner, and select your drive when it appears.
|
||||
|
||||
.. figure:: /_static/images/config/physical-backup1.png
|
||||
:width: 60%
|
||||
|
||||
.. figure:: /_static/images/config/physical-backup2.png
|
||||
:width: 60%
|
||||
|
||||
#. Enter your password to continue with the backup.
|
||||
|
||||
.. 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%
|
||||
|
||||
@@ -2,4 +2,29 @@
|
||||
|
||||
===================
|
||||
Restore From Backup
|
||||
===================
|
||||
===================
|
||||
|
||||
#. First, go to ``Embassy`` -> ``Restore From Backup``.
|
||||
|
||||
.. figure:: /_static/images/config/restore0.png
|
||||
:width: 60%
|
||||
|
||||
#. Select existing backup from either LAN or Physical. In this example, we'll select a LAN backup.
|
||||
|
||||
.. figure:: /_static/images/config/restore1.png
|
||||
:width: 60%
|
||||
|
||||
#. Click ``Restore Backup`` and enter your Embassy password.
|
||||
|
||||
.. figure:: /_static/images/config/restore2.png
|
||||
:width: 60%
|
||||
|
||||
#. Services that are available in the backup, and not already installed on your Embassy, will show in the following window. Select the service(s) you'd like to restore and click ``Restore Selected``. In the example, we'll be restoring 2 services from the available options.
|
||||
|
||||
.. figure:: /_static/images/config/restore3.png
|
||||
:width: 60%
|
||||
|
||||
#. That's it! The selected services will now install. After install, simply :ref:`configure<service-config>` and start the service.
|
||||
|
||||
.. figure:: /_static/images/config/restore4.png
|
||||
:width: 60%
|
||||
|
||||
@@ -12,11 +12,11 @@ The following will guide you through the prerequisite configuration to backup to
|
||||
|
||||
#. Open the file manager
|
||||
|
||||
#. Right-click the folder that you want to share and click ``Local Network Share`` from the menu.
|
||||
#. 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 boxes for ``Allow others to create and delete files in this folder`` and ``Guest access``.
|
||||
#. 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``.
|
||||
|
||||
#. (Optional) Create a description in the ``Comment`` section
|
||||
#. Create a description in the ``Comment`` section - remember this, you will need it later
|
||||
|
||||
#. Click ``Create Share``
|
||||
|
||||
@@ -26,18 +26,39 @@ The following will guide you through the prerequisite configuration to backup to
|
||||
|
||||
|
||||
|
||||
|
||||
.. group-tab:: Other Linux
|
||||
|
||||
#. Install Samba if it is not already installed
|
||||
#. 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
|
||||
#. 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
|
||||
#. Configure Samba, by adding the following to the end of the ``/etc/samba/smb.conf`` file:
|
||||
|
||||
#. Add your user to Samba and "own" the directory if you do not already
|
||||
.. 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>`.
|
||||
|
||||
@@ -7,14 +7,19 @@ Mac
|
||||
The following will guide you through the prerequisite configuration to backup to a Mac machine or an external drive that is attached to a Mac machine.
|
||||
|
||||
#. Go to system settings
|
||||
#. Click sharing
|
||||
#. Click file sharing
|
||||
#. Click the + under shared folders
|
||||
#. Add a folder
|
||||
#. Click options
|
||||
#. Enable Windows file sharing for the user you would like to use to authenticate
|
||||
#. 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
|
||||
|
||||
#. 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
|
||||
|
||||
22
site/source/user-manual/backups/cifs-setup/cifs-synology.rst
Normal file
22
site/source/user-manual/backups/cifs-setup/cifs-synology.rst
Normal file
@@ -0,0 +1,22 @@
|
||||
.. _cifs-synology:
|
||||
|
||||
========
|
||||
Synology
|
||||
========
|
||||
|
||||
.. 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.
|
||||
|
||||
The following will guide you through the prerequisite configuration to backup to a Synology NAS device.
|
||||
|
||||
#. Go to the Synology UI > Control Panel > Shared Folder > select the folder you want to use > Permissions tab > make sure that you have read/write permissions for the user you're going to be logging in as > Save
|
||||
|
||||
#. Then go to the Synology UI > Control Panel > File Services > SMB Tab > Click the SMB drop down button if it isn't already selected > Ensure that "Enable SMB service" is checked.
|
||||
|
||||
.. note:: Under Advanced Settings on the same dropdown, "Min SMB protocol" was set to SMB2 and "Max SMB protocol set to SMB3" - this may or may not be necessary
|
||||
|
||||
#. On 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.
|
||||
|
||||
#. Go to Synology UI > File Station > navigate so that you can see the the desired destination folder > right click on it > Properties > General Tab, next to Location: will be an folder location of the format ///, the / portion (so without the volume label) is the "Path" within the Embassy New Shared Folder dialog.
|
||||
|
||||
#. Fill in the Username and Password appropriately for the previously checked user.
|
||||
|
||||
@@ -7,13 +7,21 @@ Windows
|
||||
The following will guide you through the prerequisite configuration to backup to a Windows machine or an external drive that is attached to a Windows machine.
|
||||
|
||||
#. 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
|
||||
#. 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
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
.. _cifs-setup:
|
||||
|
||||
===========================
|
||||
Shared Network Folder Setup
|
||||
===========================
|
||||
=======================
|
||||
LAN Shared Folder Setup
|
||||
=======================
|
||||
|
||||
Click your platform for detailed instructions on how to create a Shared Network Folder.
|
||||
Click your platform for detailed instructions on how to create a Shared Network Folder on your local network (:ref:`LAN<lan>`).
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@@ -12,3 +12,4 @@ Click your platform for detailed instructions on how to create a Shared Network
|
||||
cifs-linux
|
||||
cifs-mac
|
||||
cifs-windows
|
||||
cifs-synology
|
||||
|
||||
@@ -31,13 +31,13 @@ In addition to safekeeping of a good master password, maintaining good backups a
|
||||
Restore Embassy from a previous backup.
|
||||
|
||||
.. topic-box::
|
||||
:title: SNF Setup
|
||||
: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 your laptop/desktop.
|
||||
Setup a Shared Network Folder on a desktop, laptop, or drive on your local network.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
@@ -49,4 +49,4 @@ In addition to safekeeping of a good master password, maintaining good backups a
|
||||
|
||||
backup-create
|
||||
backup-restore
|
||||
SNF Setup<cifs-setup/index>
|
||||
cifs-setup/index
|
||||
|
||||
@@ -33,8 +33,8 @@ Connecting
|
||||
</div></div>
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
lan-setup/index
|
||||
tor-setup/index
|
||||
tor-setup/index
|
||||
|
||||
@@ -32,7 +32,7 @@ Firefox
|
||||
|
||||
Firefox import certificate page
|
||||
|
||||
#. Ensure the “Embassy Local Root CA” exists under “Start9 Labs”. Then click “OK” to save.
|
||||
#. Ensure the “Embassy Local Root CA” exists under “Start9 Labs”. If it does not appear, you may need to close the Certificates pop-up and re-open to refresh the list. Then click “OK” to save.
|
||||
|
||||
#. Open a new tab in Firefox to apply the changes. If this does not work, quit and restart Firefox.
|
||||
|
||||
|
||||
@@ -4,8 +4,10 @@
|
||||
Android
|
||||
=======
|
||||
|
||||
To optimize your device for use with your Embassy, it is recommended to complete all of the following guides.
|
||||
|
||||
.. tip:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`Connecting over LAN <lan-android>` - For a fast and secure connection while on your Embassy's local network
|
||||
* :ref:`Connecting over Tor <tor-android>` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`Tor Firefox Config <torff-android>` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
* :ref:`Tor Firefox Config <torff-android>` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
@@ -4,6 +4,8 @@
|
||||
iOS
|
||||
===
|
||||
|
||||
To optimize your device for use with your Embassy, it is recommended to complete all of the following guides.
|
||||
|
||||
.. tip:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`Connecting over LAN <lan-ios>` - For a fast and secure connection while on your Embassy's local network
|
||||
* :ref:`Connecting over LAN <lan-ios>` - For a fast and secure connection while on your Embassy's local network
|
||||
|
||||
@@ -4,9 +4,11 @@
|
||||
Linux
|
||||
=====
|
||||
|
||||
To optimize your device for use with your Embassy, it is recommended to complete all of the following guides.
|
||||
|
||||
.. tip:: Please see Linux's :ref:`Known Limitations<lim-linux>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`Connecting over LAN <lan-linux>` - For a fast and secure connection while on your Embassy's local network
|
||||
* :ref:`Connecting over Tor <tor-linux>` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`Tor Firefox Config <torff-linux>` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
* :ref:`SNF Setup <cifs-linux>` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups.
|
||||
* :ref:`LAN Shared Folder Setup <cifs-linux>` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups.
|
||||
|
||||
@@ -4,9 +4,11 @@
|
||||
Mac
|
||||
===
|
||||
|
||||
To optimize your device for use with your Embassy, it is recommended to complete all of the following guides.
|
||||
|
||||
.. tip:: Please see Mac's :ref:`Known Limitations<lim-mac>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`Connecting over LAN <lan-mac>` - For a fast and secure connection while on your Embassy's local network
|
||||
* :ref:`Connecting over Tor <tor-mac>` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`Tor Firefox Config <torff-mac>` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
* :ref:`SNF Setup <cifs-mac>` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups.
|
||||
* :ref:`LAN Shared Folder Setup <cifs-mac>` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups.
|
||||
|
||||
@@ -4,9 +4,11 @@
|
||||
Windows
|
||||
=======
|
||||
|
||||
To optimize your device for use with your Embassy, it is recommended to complete all of the following guides.
|
||||
|
||||
.. tip:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices.
|
||||
|
||||
* :ref:`Connecting over LAN <lan-windows>` - For a fast and secure connection while on your Embassy's local network
|
||||
* :ref:`Connecting over Tor <tor-windows>` - Run Tor natively (in the background) on your device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`Tor Firefox Config <torff-windows>` - Configure Firefox to use the Tor Network so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
* :ref:`SNF Setup <cifs-windows>` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups.
|
||||
* :ref:`LAN Shared Folder Setup <cifs-windows>` - Configure a Shared Network Folder on your laptop/desktop (or an external drive plugged into your laptop/desktop) in order to use it for Embassy backups.
|
||||
|
||||
@@ -13,15 +13,17 @@ Welcome to the EmbassyOS user manual. Here you will discover all that you Embass
|
||||
initial-setup
|
||||
connecting/index
|
||||
dashboard-overview
|
||||
customize
|
||||
updating
|
||||
backups/index
|
||||
forgot-password
|
||||
customize
|
||||
managing-services/index
|
||||
service-guides/index
|
||||
sessions
|
||||
wifi
|
||||
ssh
|
||||
diy
|
||||
alt-marketplaces
|
||||
updating
|
||||
forgot-password
|
||||
migrate-02
|
||||
recover-03
|
||||
device-guides/index
|
||||
misc-guides/index
|
||||
|
||||
@@ -78,21 +78,43 @@ Power Up
|
||||
|
||||
#. You will be asked to enter a 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.
|
||||
|
||||
.. figure:: /_static/images/setup/migrate0.png
|
||||
:width: 60%
|
||||
|
||||
|
||||
#. Once entered, select ``Recover`` then select the microSD card - this will be labelled ``rootfs``.
|
||||
|
||||
.. figure:: /_static/images/setup/migrate1.png
|
||||
:width: 60%
|
||||
|
||||
.. figure:: /_static/images/setup/migrate2.png
|
||||
:width: 60%
|
||||
|
||||
#. On the next page you will be asked to select a storage device - here you should select your SSD.
|
||||
|
||||
.. note:: If it does not show up, please power down Embassy, unplug it, plug it back in, and boot Embassy again
|
||||
.. figure:: /_static/images/setup/migrate3.png
|
||||
:width: 60%
|
||||
|
||||
#. If this drive is not empty, you will see a warning first. If you are happy to proceed, click ``Continue``.
|
||||
.. note:: If it does not show up, please power down Embassy, unplug it, plug it back in, and boot Embassy again
|
||||
|
||||
#. 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 different one.
|
||||
#. 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``.
|
||||
|
||||
#. Embassy will now recover all your data from your old Embassy and once finished, you will hear <this>.
|
||||
.. figure:: /_static/images/setup/migrate4.png
|
||||
:width: 60%
|
||||
|
||||
#. Now you will be provided with both a Tor and LAN address with which you can access your Embassy. Please make a note of these.
|
||||
#. 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. Without this you will **LOSE ALL ACCESS** to 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 <here>.
|
||||
#. 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
|
||||
: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
|
||||
: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<lan-setup>`.
|
||||
|
||||
#. 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.
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
.. _misc-guides:
|
||||
|
||||
===========
|
||||
Misc Guides
|
||||
===========
|
||||
|
||||
Device and platform-specific guides to get the most out of your Embassy.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
diy
|
||||
ssh-tor
|
||||
migrate-02
|
||||
@@ -1,73 +0,0 @@
|
||||
.. _ssh-tor:
|
||||
|
||||
============
|
||||
SSH Over Tor
|
||||
============
|
||||
|
||||
.. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause while using SSH access.
|
||||
|
||||
.. note:: The following guide requires that you have already added an `SSH key to your Embassy<ssh>`.
|
||||
|
||||
This is currently only supported on Linux, but may work on Windows with `Torifier <https://torifier.com/>`_.
|
||||
|
||||
Setup
|
||||
-----
|
||||
|
||||
#. First, you'll need one dependency, ``torsocks``, which will allow you to use SSH over Tor on the machine that you want access with. Select your Linux flavor to install:
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Debian / Ubuntu
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
apt install torsocks
|
||||
|
||||
.. group-tab:: Arch / Garuda / Manjaro
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pacman -S torsocks
|
||||
|
||||
#. SSH in:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
ssh root@embassy-xxxxxxx.local
|
||||
|
||||
#. Add the following 2 lines to ``/etc/tor/torrc`` **EITHER** by using your preferred text editor (such as ``nano`` or ``vim``):
|
||||
|
||||
``HiddenServiceDir /var/lib/tor/ssh``
|
||||
``HiddenServicePort 22 127.0.0.1:22``
|
||||
|
||||
**OR** by entering the following 2 commands:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
echo "HiddenServiceDir /var/lib/tor/ssh" >> /etc/tor/torrc
|
||||
echo "HiddenServicePort 22 127.0.0.1:22" >> /etc/tor/torrc
|
||||
|
||||
#. Then reload the Tor configuration with your edits:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
systemctl reload tor
|
||||
|
||||
#. Next, gather the ``.onion`` address you just created:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
cat /var/lib/tor/ssh/hostname
|
||||
|
||||
.. note:: All these changes are on the overlay and won't persist after a restart of your Embassy
|
||||
|
||||
#. Add an additional SSH key in your EmbassyUI if you want to access from a machine other than the one you did this setup with.
|
||||
|
||||
Access
|
||||
------
|
||||
|
||||
Now to log in, simply use the following command, using the ``.onion`` hostname you printed above:
|
||||
|
||||
.. code-block::
|
||||
|
||||
torsocks ssh root@xxxxxxxxxxxxxxxxx.onion
|
||||
57
site/source/user-manual/recover-03.rst
Normal file
57
site/source/user-manual/recover-03.rst
Normal file
@@ -0,0 +1,57 @@
|
||||
.. _recover-03:
|
||||
|
||||
======================
|
||||
Recover 0.3 Data Drive
|
||||
======================
|
||||
|
||||
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).
|
||||
|
||||
Instructions
|
||||
------------
|
||||
|
||||
#. Plug up all your hardware
|
||||
|
||||
- New EOS install, flashed on sd card
|
||||
- Old SSD with 0.3.x data that you are recovering from
|
||||
- Ethernet cable
|
||||
- Finally, power cable to boot device
|
||||
|
||||
#. 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.
|
||||
|
||||
#. On your computer, open up a browser and go to ``embassy.local``. You will be asked to enter a 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.
|
||||
|
||||
.. figure:: /_static/images/setup/migrate0.png
|
||||
:width: 60%
|
||||
|
||||
#. Once entered, select ``Recover`` then select the ``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. Do so, then select the drive.
|
||||
|
||||
.. figure:: /_static/images/setup/migrate1.png
|
||||
:width: 60%
|
||||
|
||||
.. figure:: /_static/images/setup/migrate3.png
|
||||
:width: 60%
|
||||
|
||||
.. note:: If it does not show up, please power down Embassy, unplug it, plug it back in, and boot Embassy again
|
||||
|
||||
#. 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 recovery, or a new one. Either way, make it strong, and make a backup of it. Without this you will **LOSE ALL ACCESS** to your Embassy!
|
||||
|
||||
#. Embassy will now recover all your data from your old Embassy and once finished, you will hear a _bep_ then a _chime_.
|
||||
|
||||
.. figure:: /_static/images/setup/migrate5.png
|
||||
: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. These will be the same as your Embassy previous to recovery.
|
||||
|
||||
.. figure:: /_static/images/setup/migrate6.png
|
||||
: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<lan-setup>`.
|
||||
|
||||
#. 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.
|
||||
|
||||
.. note:: For those recovering Bitwarden - it is now called Vaultwarden.
|
||||
@@ -8,12 +8,18 @@ Using SSH
|
||||
|
||||
.. tip:: An ED25519 key is strongly recommended. If you have issues with any other type of key, please consider using an ED25519.
|
||||
|
||||
Setting Up SSH Access
|
||||
---------------------
|
||||
|
||||
Connecting via CLI (Linux / Mac)
|
||||
--------------------------------
|
||||
================================
|
||||
|
||||
#. Navigate to the ``Embassy`` tab, then under ``Settings``, click ``SSH``
|
||||
#. Click the ``+ Add New Key`` button
|
||||
#. Paste in your SSH public key and hit ``Submit``
|
||||
|
||||
.. tip:: This is typically found under your ``home`` in the ``.ssh`` directory and the file should end in ``.pub`` - copy the entire contents of the file.
|
||||
|
||||
#. You can now access your Embassy from the command line (Linux and Mac) using:
|
||||
|
||||
.. code-block:: bash
|
||||
@@ -23,6 +29,75 @@ Connecting via CLI (Linux / Mac)
|
||||
Replacing ``<LAN URL>`` with your Embassy's LAN (``embassy-xxxxxxx.local``) address
|
||||
|
||||
Connecting via SSH on Windows, using PuTTY
|
||||
------------------------------------------
|
||||
==========================================
|
||||
|
||||
One of our community members, `@brewsbitcoin <https://twitter.com/brewsbitcoin>`_ (https://brewsbitcoin.com/), has put together this `Guide <https://medium.com/@brewsbitcoin/ssh-to-start9-embassy-from-windows-4a4e17891b5a>`_ for connecting via PuTTY on Windows.
|
||||
|
||||
Setting Up Remote SSH Access (Tor)
|
||||
----------------------------------
|
||||
|
||||
.. note:: The following guide requires that you have already added an `SSH key to your Embassy<ssh>`.
|
||||
|
||||
This guide will allow you remote SSH access via Tor. Currently only supported on Linux, but may work on Windows with `Torifier <https://torifier.com/>`_. Currently, this setup will not persist after a reboot.
|
||||
|
||||
Setup
|
||||
=====
|
||||
|
||||
#. First, you'll need one dependency, ``torsocks``, which will allow you to use SSH over Tor on the machine that you want access with. Select your Linux flavor to install:
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Debian / Ubuntu
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
apt install torsocks
|
||||
|
||||
.. group-tab:: Arch / Garuda / Manjaro
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pacman -S torsocks
|
||||
|
||||
#. SSH in:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
ssh root@embassy-xxxxxxx.local
|
||||
|
||||
#. Add the following 2 lines to ``/etc/tor/torrc`` **EITHER** by using your preferred text editor (such as ``nano`` or ``vim``):
|
||||
|
||||
``HiddenServiceDir /var/lib/tor/ssh``
|
||||
``HiddenServicePort 22 127.0.0.1:22``
|
||||
|
||||
**OR** by entering the following 2 commands:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
echo "HiddenServiceDir /var/lib/tor/ssh" >> /etc/tor/torrc
|
||||
echo "HiddenServicePort 22 127.0.0.1:22" >> /etc/tor/torrc
|
||||
|
||||
#. Then reload the Tor configuration with your edits:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
systemctl reload tor
|
||||
|
||||
#. Next, gather the ``.onion`` address you just created:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
cat /var/lib/tor/ssh/hostname
|
||||
|
||||
.. note:: All these changes are on the overlay and won't persist after a restart of your Embassy
|
||||
|
||||
#. Add an additional SSH key in your EmbassyUI if you want to access from a machine other than the one you did this setup with.
|
||||
|
||||
Access
|
||||
======
|
||||
|
||||
Now to log in, simply use the following command, using the ``.onion`` hostname you printed above:
|
||||
|
||||
.. code-block::
|
||||
|
||||
torsocks ssh root@xxxxxxxxxxxxxxxxx.onion
|
||||
|
||||
Reference in New Issue
Block a user