Backup updates

This commit is contained in:
kn0wmad
2022-01-24 06:35:56 -07:00
committed by Lucy Cifferello
parent b9c81d12aa
commit e028278168
17 changed files with 118 additions and 42 deletions

View File

@@ -1,38 +0,0 @@
.. _backup-lin:
=====
Linux
=====
There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop or desktop, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy.
Remote Backups
--------------
Ubuntu
======
#. Open the file manager
#. Right-click the folder that you want to share 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.
#. (Optional) Create a description in the ``Comment`` section
#. Click ``Create Share``
#. Click ``Add the permissions automatically``
#. Next, in your Embassy interface, go to ``Embassy`` -> ``Create Backup``
Other Linux
===========
#. Install Samba
# sudo yum install samba For CentOS/Redhat
# sudo dnf install samba For Fedora
# sudo apt install samba For Debian
# sudo pacman -S samba For Arch
Local Backups
-------------
#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered.
#. Plug in power to your hub or drive
#. Boot Embassy and go to ``Embassy`` -> ``Create Backup``
#.

View File

@@ -1,30 +0,0 @@
.. _backup-mac:
===
Mac
===
There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop or desktop, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy.
Remote Backups
--------------
#. 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
Local Backups
-------------
#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered.
#. Plug in power to your hub or drive
#. Boot Embassy and go to ``Embassy`` -> ``Create Backup``
#.

View File

@@ -1,30 +0,0 @@
.. _backups-win:
=======
Windows
=======
There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop or desktop, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy.
Remote Backups
--------------
#. 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
#. 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
Local Backups
-------------
#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered.
#. Plug in power to your hub or drive
#. Boot Embassy and go to ``Embassy`` -> ``Create Backup``
#.

View File

@@ -1,14 +0,0 @@
.. _backup:
=======
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.
.. toctree::
:maxdepth: 2
backup-lin
backup-mac
backup-win

View File

@@ -0,0 +1,60 @@
.. _backups:
==============
Making Backups
==============
There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop, desktop, or external drive on your network, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy.
.. note:: For remote backups, you will first need to configure the machine you want to backup to. Check our :ref:`Backup Setup<backup-setup>` guide for your OS first.
Remote Backups
--------------
#. Go to the :ref:`Embassy tab<embassy-tab>`, then click on ``Create Backup``.
.. figure:: /_static/images/config/embassy_backup.svg
:width: 60%
#. Next, click on ``+ New Shared Folder`` to use your previously created backup folder.
.. figure:: /_static/images/config/embassy_backup0.svg
:width: 60%
#. 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.
* 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.svg
:width: 60%
Then click ``Save``
#. You will see a freshly created "cloud" backup location available, click it for options, and click ``Create Backup`` to begin.
.. figure:: /_static/images/config/embassy_backup2.svg
:width: 60%
#. You can continue to use your Embassy while the backup is in progress.
.. figure:: /_static/images/config/embassy_backup3.svg
:width: 60%
#. When the backup is complete you will be notified in the :ref:`Notifications tab<notifications-tab>`, and 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.svg
:width: 60%
Local Backups
-------------
#. With Embassy powered down, plug in your external drive to the powered hub if you are using one, or directly into Embassy's available USB 3.0 (blue) slot if it is externally powered.
#. Plug in power to your hub or drive
#. Boot Embassy and go to ``Embassy`` -> ``Create Backup``
#.

View File

@@ -11,7 +11,8 @@ An overview of EmbassyOS general capabilities.
overview
updates
backup/index
backups
password
sessions

View File

@@ -0,0 +1,12 @@
.. _active-sessions:
===============
Active Sessions
===============
Every time a login is made with Embassy, such as from a web browser on your laptop or mobile device, a :ref:`Session <sessions>` is created. You can see these listed in the ``Embassy`` tab, under ``Active Sessions``.
To end a session, simply click ``Kill`` to the right of your selection.
.. figure:: /_static/images/walkthrough/sessions0.svg
:width: 60%