mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 04:01:59 +00:00
re-arrange the user docs (#76)
* re-arrange the user docs * Minor description edit * update styles * fix service links Co-authored-by: kn0wmad <kn0wmad@protonmail.com> Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
This commit is contained in:
63
site/source/user-manual/backups/backup-create.rst
Normal file
63
site/source/user-manual/backups/backup-create.rst
Normal file
@@ -0,0 +1,63 @@
|
||||
.. _backup-create:
|
||||
|
||||
================
|
||||
Creating Backups
|
||||
================
|
||||
|
||||
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
|
||||
---------------------
|
||||
|
||||
This is the recommended approach for creating backups.
|
||||
|
||||
#. Follow instructions for creating a :ref:`Shared Network Folder<cifs-setup>` on your laptop/desktop.
|
||||
|
||||
#. Go to the :ref:`Embassy tab<embassy-tab>`, then click on ``Create Backup``.
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup.png
|
||||
:width: 60%
|
||||
|
||||
#. Next, click on ``+ New Shared Folder`` to use your previously created backup 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 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.png
|
||||
: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.png
|
||||
:width: 60%
|
||||
|
||||
#. You can continue to use your Embassy while the backup is in progress.
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup3.png
|
||||
: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.png
|
||||
:width: 60%
|
||||
|
||||
Physical Drive
|
||||
--------------
|
||||
|
||||
#. 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.
|
||||
|
||||
#. Go to ``Embassy`` -> ``Create Backup``
|
||||
|
||||
#. Select the drive
|
||||
5
site/source/user-manual/backups/backup-restore.rst
Normal file
5
site/source/user-manual/backups/backup-restore.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
.. _backup-restore:
|
||||
|
||||
===================
|
||||
Restore From Backup
|
||||
===================
|
||||
43
site/source/user-manual/backups/cifs-setup/cifs-linux.rst
Normal file
43
site/source/user-manual/backups/cifs-setup/cifs-linux.rst
Normal file
@@ -0,0 +1,43 @@
|
||||
.. _cifs-lin:
|
||||
|
||||
=====
|
||||
Linux
|
||||
=====
|
||||
|
||||
The following will guide you through the prerequisite configuration to backup to a Linux machine or an external drive that is attached to a Linux machine.
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: 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``
|
||||
|
||||
#. 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
|
||||
|
||||
#. Configure Samba
|
||||
|
||||
#. Add your user to Samba and "own" the directory if you do not already
|
||||
20
site/source/user-manual/backups/cifs-setup/cifs-mac.rst
Normal file
20
site/source/user-manual/backups/cifs-setup/cifs-mac.rst
Normal file
@@ -0,0 +1,20 @@
|
||||
.. _cifs-mac:
|
||||
|
||||
===
|
||||
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
|
||||
|
||||
19
site/source/user-manual/backups/cifs-setup/cifs-windows.rst
Normal file
19
site/source/user-manual/backups/cifs-setup/cifs-windows.rst
Normal file
@@ -0,0 +1,19 @@
|
||||
.. _cifs-win:
|
||||
|
||||
=======
|
||||
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
|
||||
#. 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
|
||||
14
site/source/user-manual/backups/cifs-setup/index.rst
Normal file
14
site/source/user-manual/backups/cifs-setup/index.rst
Normal file
@@ -0,0 +1,14 @@
|
||||
.. _cifs-setup:
|
||||
|
||||
===========================
|
||||
Shared Network Folder Setup
|
||||
===========================
|
||||
|
||||
Click your platform for detailed instructions on how to create a Shared Network Folder.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
cifs-linux
|
||||
cifs-mac
|
||||
cifs-windows
|
||||
52
site/source/user-manual/backups/index.rst
Normal file
52
site/source/user-manual/backups/index.rst
Normal file
@@ -0,0 +1,52 @@
|
||||
.. _backups:
|
||||
|
||||
=======
|
||||
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.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Create
|
||||
:link: backup-create
|
||||
:icon: scylla-icon scylla-icon--memory-management
|
||||
:class: large-5
|
||||
:anchor: View
|
||||
|
||||
Create an encrypted backup of Embassy.
|
||||
|
||||
.. topic-box::
|
||||
:title: Restore
|
||||
:link: backup-restore
|
||||
:icon: scylla-icon scylla-icon--comparison
|
||||
:class: large-5
|
||||
:anchor: View
|
||||
|
||||
Restore Embassy from a previous backup.
|
||||
|
||||
.. topic-box::
|
||||
:title: SNF 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.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
</div></div>
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
backup-create
|
||||
backup-restore
|
||||
SNF Setup<cifs-setup/index>
|
||||
Reference in New Issue
Block a user