diff --git a/site/03-todo.md b/site/03-todo.md index 88f7ef1..caee33a 100644 --- a/site/03-todo.md +++ b/site/03-todo.md @@ -45,3 +45,10 @@ - Alt Market Build Guide # About - Mission / values +- Backups + - CIFS + - OS guides for CIFS + - Local +- Migrations +- Bug reports +- Diag UI diff --git a/site/source/_static/images/config/embassy_backup.svg b/site/source/_static/images/config/embassy_backup.svg new file mode 100644 index 0000000..70a30e8 Binary files /dev/null and b/site/source/_static/images/config/embassy_backup.svg differ diff --git a/site/source/_static/images/config/embassy_backup0.svg b/site/source/_static/images/config/embassy_backup0.svg new file mode 100644 index 0000000..344c7cd Binary files /dev/null and b/site/source/_static/images/config/embassy_backup0.svg differ diff --git a/site/source/_static/images/config/embassy_backup1.svg b/site/source/_static/images/config/embassy_backup1.svg new file mode 100644 index 0000000..3aa9222 Binary files /dev/null and b/site/source/_static/images/config/embassy_backup1.svg differ diff --git a/site/source/_static/images/config/embassy_backup2.svg b/site/source/_static/images/config/embassy_backup2.svg new file mode 100644 index 0000000..53fb6ef Binary files /dev/null and b/site/source/_static/images/config/embassy_backup2.svg differ diff --git a/site/source/_static/images/config/embassy_backup3.svg b/site/source/_static/images/config/embassy_backup3.svg new file mode 100644 index 0000000..0e16e65 Binary files /dev/null and b/site/source/_static/images/config/embassy_backup3.svg differ diff --git a/site/source/_static/images/config/embassy_backup4.svg b/site/source/_static/images/config/embassy_backup4.svg new file mode 100644 index 0000000..d3faef3 Binary files /dev/null and b/site/source/_static/images/config/embassy_backup4.svg differ diff --git a/site/source/support/index.rst b/site/source/support/index.rst index 65b7ae7..63281b8 100644 --- a/site/source/support/index.rst +++ b/site/source/support/index.rst @@ -30,7 +30,7 @@ :class: large-4 :anchor: View - All you need to be an owner/operator of your own self-hosted software + All you need to be the owner/operator of your own self-hosted software .. topic-box:: :title: FAQ diff --git a/site/source/support/user-manual/configuration/backup-setup/backup-lin.rst b/site/source/support/user-manual/configuration/backup-setup/backup-lin.rst new file mode 100644 index 0000000..a89d546 --- /dev/null +++ b/site/source/support/user-manual/configuration/backup-setup/backup-lin.rst @@ -0,0 +1,46 @@ +.. _backup-lin: + +===== +Linux +===== + +Remote Backups +-------------- + +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`` in the Embassy UI. + + .. figure:: /_static/images/ + + + .. 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 diff --git a/site/source/support/user-manual/walkthrough/backup/backup-mac.rst b/site/source/support/user-manual/configuration/backup-setup/backup-mac.rst similarity index 100% rename from site/source/support/user-manual/walkthrough/backup/backup-mac.rst rename to site/source/support/user-manual/configuration/backup-setup/backup-mac.rst diff --git a/site/source/support/user-manual/walkthrough/backup/backup-win.rst b/site/source/support/user-manual/configuration/backup-setup/backup-win.rst similarity index 100% rename from site/source/support/user-manual/walkthrough/backup/backup-win.rst rename to site/source/support/user-manual/configuration/backup-setup/backup-win.rst diff --git a/site/source/support/user-manual/walkthrough/backup/index.rst b/site/source/support/user-manual/configuration/backup-setup/index.rst similarity index 94% rename from site/source/support/user-manual/walkthrough/backup/index.rst rename to site/source/support/user-manual/configuration/backup-setup/index.rst index 32a1a7f..fd45126 100644 --- a/site/source/support/user-manual/walkthrough/backup/index.rst +++ b/site/source/support/user-manual/configuration/backup-setup/index.rst @@ -1,4 +1,4 @@ -.. _backup: +.. _backup-setup: ======= Backups diff --git a/site/source/support/user-manual/configuration/index.rst b/site/source/support/user-manual/configuration/index.rst index c2588b2..42453b5 100644 --- a/site/source/support/user-manual/configuration/index.rst +++ b/site/source/support/user-manual/configuration/index.rst @@ -10,8 +10,8 @@ Configuration, setup guides, and known limitations are provided here by device. :maxdepth: 2 basic-config + backup-setup/index tor-setup/index lan-setup/index wifi - sessions limitations/index diff --git a/site/source/support/user-manual/walkthrough/backup/backup-lin.rst b/site/source/support/user-manual/walkthrough/backup/backup-lin.rst deleted file mode 100644 index 10fa87f..0000000 --- a/site/source/support/user-manual/walkthrough/backup/backup-lin.rst +++ /dev/null @@ -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`` -#. diff --git a/site/source/support/user-manual/walkthrough/backups.rst b/site/source/support/user-manual/walkthrough/backups.rst new file mode 100644 index 0000000..44991f0 --- /dev/null +++ b/site/source/support/user-manual/walkthrough/backups.rst @@ -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` guide for your OS first. + +Remote Backups +-------------- + +#. Go to the :ref:`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`, 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`` + +#. diff --git a/site/source/support/user-manual/walkthrough/index.rst b/site/source/support/user-manual/walkthrough/index.rst index 1901fd8..ca410cd 100644 --- a/site/source/support/user-manual/walkthrough/index.rst +++ b/site/source/support/user-manual/walkthrough/index.rst @@ -11,7 +11,8 @@ An overview of EmbassyOS general capabilities. overview updates - backup/index + backups password + sessions diff --git a/site/source/support/user-manual/configuration/sessions.rst b/site/source/support/user-manual/walkthrough/sessions.rst similarity index 100% rename from site/source/support/user-manual/configuration/sessions.rst rename to site/source/support/user-manual/walkthrough/sessions.rst