Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-04-01 21:13:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Edits for release (#77)

Browse Source 
* 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
2022-02-22 12:44:14 -07:00
committed by GitHub
parent b34aedba67
commit df6cc9b23f
47 changed files with 376 additions and 210 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
site/source/user-manual/backups/backup-create.rst
View File

@@ -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%

27
site/source/user-manual/backups/backup-restore.rst
View File

@@ -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%

37
site/source/user-manual/backups/cifs-setup/cifs-linux.rst
View File

@@ -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>`.

25
site/source/user-manual/backups/cifs-setup/cifs-mac.rst
View File

@@ -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
View 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.

12
site/source/user-manual/backups/cifs-setup/cifs-windows.rst
View File

@@ -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

9
site/source/user-manual/backups/cifs-setup/index.rst
View File

@@ -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

6
site/source/user-manual/backups/index.rst
View File

@@ -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