mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 04:01:59 +00:00
a bunch of changes
This commit is contained in:
Matt Hill
@@ -1,44 +1,41 @@
|
||||
.. _backup-create:
|
||||
|
||||
================
|
||||
Creating Backups
|
||||
================
|
||||
=============
|
||||
Backup Create
|
||||
=============
|
||||
|
||||
There are 2 options for backing up your Embassy and service data:
|
||||
Backing up your Embassy is easy and secure. Backups are encrypted with your master password.
|
||||
|
||||
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.
|
||||
Backup Using LAN Shared Folder
|
||||
------------------------------
|
||||
|
||||
LAN Backups
|
||||
-----------
|
||||
.. tip:: This is the recommended approach for creating backups.
|
||||
|
||||
This is the recommended approach for creating backups.
|
||||
#. Follow instructions for creating a :ref:`LAN Shared Folder<cifs-setup>` on your laptop/desktop.
|
||||
|
||||
#. 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``.
|
||||
#. Go to *Embassy > Create Backup*.
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup.png
|
||||
:width: 60%
|
||||
|
||||
#. Next, click on ``+ New Shared Folder`` to use your previously created backup folder.
|
||||
#. 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 folder or drive 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.
|
||||
* 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%
|
||||
|
||||
Then click ``Save``
|
||||
#. Click "Save".
|
||||
|
||||
#. You will see a freshly created "cloud" backup location available, click it for options, and click ``Create Backup`` to begin.
|
||||
#. You will see a freshly created "cloud" backup location available, click it, then click "Create Backup".
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup2.png
|
||||
:width: 60%
|
||||
@@ -48,26 +45,28 @@ This is the recommended approach for creating backups.
|
||||
.. 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.
|
||||
#. 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.
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup4.png
|
||||
:width: 60%
|
||||
|
||||
Physical Backups
|
||||
----------------
|
||||
Backup Using a Physical Drive
|
||||
-----------------------------
|
||||
|
||||
You may use a drive by attaching to Embassy directly if you prefer. The recommended format at this time is ``exFAT``.
|
||||
.. 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.
|
||||
|
||||
#. First, go to ``Embassy`` -> ``Create Backup``
|
||||
#. 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%
|
||||
|
||||
#. 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.
|
||||
#. Select your drive.
|
||||
|
||||
.. figure:: /_static/images/config/physical-backup1.png
|
||||
:width: 60%
|
||||
@@ -75,7 +74,7 @@ You may use a drive by attaching to Embassy directly if you prefer. The recomme
|
||||
.. figure:: /_static/images/config/physical-backup2.png
|
||||
:width: 60%
|
||||
|
||||
#. Enter your password to continue with the backup.
|
||||
#. Enter your EmbassyOS master password.
|
||||
|
||||
.. figure:: /_static/images/config/physical-backup3.png
|
||||
:width: 60%
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
.. _backup-restore:
|
||||
|
||||
===================
|
||||
Restore From Backup
|
||||
===================
|
||||
==============
|
||||
Backup Restore
|
||||
==============
|
||||
|
||||
#. First, go to ``Embassy`` -> ``Restore From Backup``.
|
||||
#. 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.
|
||||
#. 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.
|
||||
#. Click "Restore Backup" and enter your master 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.
|
||||
#. 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".
|
||||
|
||||
.. 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%
|
||||
|
||||
@@ -1,10 +1,8 @@
|
||||
.. _cifs-linux:
|
||||
|
||||
=====
|
||||
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.
|
||||
=====================================
|
||||
Creating a LAN Shared Folder on Linux
|
||||
=====================================
|
||||
|
||||
.. tabs::
|
||||
|
||||
|
||||
@@ -1,10 +1,8 @@
|
||||
.. _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.
|
||||
===================================
|
||||
Creating a LAN Shared Folder on Mac
|
||||
===================================
|
||||
|
||||
#. Go to system settings
|
||||
|
||||
|
||||
@@ -1,22 +1,17 @@
|
||||
.. _cifs-synology:
|
||||
|
||||
========
|
||||
Synology
|
||||
========
|
||||
========================================
|
||||
Creating a LAN Shared Folder on 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.
|
||||
#. 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".
|
||||
|
||||
#. 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.
|
||||
#. 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.
|
||||
|
||||
.. 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.
|
||||
#. 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.
|
||||
@@ -1,10 +1,8 @@
|
||||
.. _cifs-windows:
|
||||
|
||||
=======
|
||||
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.
|
||||
=======================================
|
||||
Creating a LAN Shared Folder on Windows
|
||||
=======================================
|
||||
|
||||
#. Create a folder
|
||||
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
.. _cifs-setup:
|
||||
|
||||
=======================
|
||||
LAN Shared Folder Setup
|
||||
=======================
|
||||
============================
|
||||
Creating a LAN Shared Folder
|
||||
============================
|
||||
|
||||
Click your platform for detailed instructions on how to create a Shared Network Folder on your local network (:ref:`LAN<lan>`).
|
||||
Click your platform for detailed instructions on how to create a LAN Shared Folder for creating backups.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
cifs-linux
|
||||
cifs-mac
|
||||
cifs-windows
|
||||
cifs-synology
|
||||
Linux <cifs-linux>
|
||||
Mac <cifs-mac>
|
||||
Windows <cifs-windows>
|
||||
Synonogy <cifs-synology>
|
||||
|
||||
@@ -13,7 +13,7 @@ In addition to safekeeping of a good master password, maintaining good backups a
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Create
|
||||
:title: Create Backup
|
||||
:link: backup-create
|
||||
:icon: scylla-icon scylla-icon--memory-management
|
||||
:class: large-5
|
||||
@@ -22,7 +22,7 @@ In addition to safekeeping of a good master password, maintaining good backups a
|
||||
Create an encrypted backup of Embassy.
|
||||
|
||||
.. topic-box::
|
||||
:title: Restore
|
||||
:title: Restore from Backup
|
||||
:link: backup-restore
|
||||
:icon: scylla-icon scylla-icon--comparison
|
||||
:class: large-5
|
||||
|
||||
Reference in New Issue
Block a user