Touchups to Linux Samba-share instructions (#138)

* Touchups to Linux Samba-share instructions

* Added quotes around path in smb.conf (necessary if any spaces are used in a folder name)

* Moved Ubuntu into Ubuntu section under video, below Ubuntu/Other Linux tabs so they can be more visually prominent

* Add note admonition about Ubuntu vs Other Linux

* add linebreak

* Updated screenshot for network share entry & added Path hint

* Updated path hint quotation
This commit is contained in:
gStart9
2022-06-30 22:16:39 +00:00
committed by GitHub
parent 517dca20a2
commit c2a2a8a093
3 changed files with 33 additions and 27 deletions

18
poetry.lock generated
View File

@@ -72,11 +72,11 @@ python-versions = ">=3.6"
[[package]] [[package]]
name = "charset-normalizer" name = "charset-normalizer"
version = "2.0.12" version = "2.1.0"
description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet."
category = "main" category = "main"
optional = false optional = false
python-versions = ">=3.5.0" python-versions = ">=3.6.0"
[package.extras] [package.extras]
unicode_backport = ["unicodedata2"] unicode_backport = ["unicodedata2"]
@@ -305,7 +305,7 @@ sphinx = ">=1.3.1"
[[package]] [[package]]
name = "requests" name = "requests"
version = "2.28.0" version = "2.28.1"
description = "Python HTTP for Humans." description = "Python HTTP for Humans."
category = "main" category = "main"
optional = false optional = false
@@ -313,13 +313,13 @@ python-versions = ">=3.7, <4"
[package.dependencies] [package.dependencies]
certifi = ">=2017.4.17" certifi = ">=2017.4.17"
charset-normalizer = ">=2.0.0,<2.1.0" charset-normalizer = ">=2,<3"
idna = ">=2.5,<4" idna = ">=2.5,<4"
urllib3 = ">=1.21.1,<1.27" urllib3 = ">=1.21.1,<1.27"
[package.extras] [package.extras]
socks = ["PySocks (>=1.5.6,!=1.5.7)"] socks = ["PySocks (>=1.5.6,!=1.5.7)"]
use_chardet_on_py3 = ["chardet (>=3.0.2,<5)"] use_chardet_on_py3 = ["chardet (>=3.0.2,<6)"]
[[package]] [[package]]
name = "six" name = "six"
@@ -688,8 +688,8 @@ certifi = [
{file = "certifi-2022.6.15.tar.gz", hash = "sha256:84c85a9078b11105f04f3036a9482ae10e4621616db313fe045dd24743a0820d"}, {file = "certifi-2022.6.15.tar.gz", hash = "sha256:84c85a9078b11105f04f3036a9482ae10e4621616db313fe045dd24743a0820d"},
] ]
charset-normalizer = [ charset-normalizer = [
{file = "charset-normalizer-2.0.12.tar.gz", hash = "sha256:2857e29ff0d34db842cd7ca3230549d1a697f96ee6d3fb071cfa6c7393832597"}, {file = "charset-normalizer-2.1.0.tar.gz", hash = "sha256:575e708016ff3a5e3681541cb9d79312c416835686d054a23accb873b254f413"},
{file = "charset_normalizer-2.0.12-py3-none-any.whl", hash = "sha256:6881edbebdb17b39b4eaaa821b438bf6eddffb4468cf344f09f89def34a8b1df"}, {file = "charset_normalizer-2.1.0-py3-none-any.whl", hash = "sha256:5189b6f22b01957427f35b6a08d9a0bc45b46d3788ef5a92e978433c7a35f8a5"},
] ]
colorama = [ colorama = [
{file = "colorama-0.4.5-py2.py3-none-any.whl", hash = "sha256:854bf444933e37f5824ae7bfc1e98d5bce2ebe4160d46b5edf346a89358e99da"}, {file = "colorama-0.4.5-py2.py3-none-any.whl", hash = "sha256:854bf444933e37f5824ae7bfc1e98d5bce2ebe4160d46b5edf346a89358e99da"},
@@ -842,8 +842,8 @@ recommonmark = [
{file = "recommonmark-0.5.0.tar.gz", hash = "sha256:a520b8d25071a51ae23a27cf6252f2fe387f51bdc913390d83b2b50617f5bb48"}, {file = "recommonmark-0.5.0.tar.gz", hash = "sha256:a520b8d25071a51ae23a27cf6252f2fe387f51bdc913390d83b2b50617f5bb48"},
] ]
requests = [ requests = [
{file = "requests-2.28.0-py3-none-any.whl", hash = "sha256:bc7861137fbce630f17b03d3ad02ad0bf978c844f3536d0edda6499dafce2b6f"}, {file = "requests-2.28.1-py3-none-any.whl", hash = "sha256:8fefa2a1a1365bf5520aac41836fbee479da67864514bdb821f31ce07ce65349"},
{file = "requests-2.28.0.tar.gz", hash = "sha256:d568723a7ebd25875d8d1eaf5dfa068cd2fc8194b2e483d7b1f7c81918dbec6b"}, {file = "requests-2.28.1.tar.gz", hash = "sha256:7c5599b102feddaa661c826c56ab4fee28bfd17f5abca1ebbe3e7f19d7c97983"},
] ]
six = [ six = [
{file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"}, {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"},

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 29 KiB

View File

@@ -7,20 +7,26 @@ Linux LAN Shared Folder
.. contents:: .. contents::
:depth: 2 :depth: 2
:local: :local:
Check out the video below, and follow along with the steps in this guide to setup a LAN Shared folder on your Linux machine, such that you may create encrypted, private backups of all your Embassy data.
.. youtube:: LLIMC5P3NdY
:width: 100%
Setup LAN Shared Folder Setup LAN Shared Folder
----------------------- -----------------------
.. note:: This guide is for Ubuntu only. For different distros such as Arch, Debian, Pop-OS, PureOS, etc, click "Other Linux" below.
.. tabs:: .. tabs::
.. group-tab:: Ubuntu .. group-tab:: Ubuntu
#. Install ``Samba`` if you have not already: Check out the video below, and follow along with the steps in this guide to setup a LAN Shared folder on your Linux machine, such that you may create encrypted, private backups of all your Embassy data.
.. youtube:: LLIMC5P3NdY
:width: 100%
.. raw:: html
<br/><br/>
#. Install Samba if you have not already:
.. code-block:: .. code-block::
@@ -70,26 +76,26 @@ Setup LAN Shared Folder
#. Install Samba if it is not already installed. #. Install Samba if it is not already installed.
* ``sudo pacman -S samba`` For Arch * ``sudo pacman -S samba`` For Arch
* ``sudo apt install samba`` For Debian * ``sudo apt install samba`` For Debian-based distros (Pop-OS, PureOS, etc)
* ``sudo yum install samba`` For CentOS/Redhat * ``sudo yum install samba`` For CentOS/Redhat
* ``sudo dnf install samba`` For Fedora * ``sudo dnf install samba`` For Fedora
#. 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/user/test-backup`` #. Create a directory to share or choose an existing one and make note of its location (path). For this example, we will call the share ``backup-share`` and its corresponding shared directory will be located at ``/home/user/embassy-backup``
#. Configure Samba, by adding the following to the end of the ``/etc/samba/smb.conf`` file: #. Configure Samba by adding the following to the end of the ``/etc/samba/smb.conf`` file:
.. code-block:: .. code-block::
[test-share] [backup-share]
path = /home/user/test-backup path = "/home/user/embassy-backup"
create mask = 0666 create mask = 0600
directory mask = 0777 directory mask = 0700
read only = no read only = no
guest ok = no guest ok = no
Where: Where:
- ``[test-share]`` is the *Share Name*, or title of the entry, and can be called anything you'd like - ``[backup-share]`` is the *Share Name*, or title of the entry, and can be called anything you'd like
- ``path`` should be the path to the directory you created earlier - ``path`` should be the path to the directory you created earlier
Copy the remainder of the entry exactly as it is Copy the remainder of the entry exactly as it is
@@ -100,7 +106,7 @@ Setup LAN Shared Folder
sudo smbpasswd -a YOUR-USER sudo smbpasswd -a YOUR-USER
Create a password and keep it somewhere safe, such as Vaultwarden This creates a password for the Local Network Share. Keep it somewhere safe, such as Vaultwarden.
Connect Embassy Connect Embassy
@@ -119,9 +125,9 @@ Connect Embassy
#. Fill in the following fields: #. Fill in the following fields:
* Hostname - This is the hostname of the machine that your shared folder is located on * Hostname - This is the hostname of the machine that your shared folder is located on
* Path - This is the "Share Name" (name of the share in your samba config) and **not** the full directory path * Path - This is the "Share Name" (name of the share in your samba config) and **not** the full directory path. In this guide we used ``backup-share``
* Username - This is the user on the remote machine that you used to create the shared directory * Username - This is your Linux username on the remote machine that you used to create the shared directory
* Password - This is your user (from above) password * Password - This is the password you set above using ``smbpasswd``
.. figure:: /_static/images/config/embassy_backup1.png .. figure:: /_static/images/config/embassy_backup1.png
:width: 60% :width: 60%