diff --git a/site/source/_static/images/cifs/cifs-lin2.png b/site/source/_static/images/cifs/cifs-lin2.png index 20d5c97..3a694f7 100644 Binary files a/site/source/_static/images/cifs/cifs-lin2.png and b/site/source/_static/images/cifs/cifs-lin2.png differ diff --git a/site/source/user-manual/backups/backup-setup/backup-linux.rst b/site/source/user-manual/backups/backup-setup/backup-linux.rst index 720eee9..4eb37f5 100644 --- a/site/source/user-manual/backups/backup-setup/backup-linux.rst +++ b/site/source/user-manual/backups/backup-setup/backup-linux.rst @@ -17,7 +17,7 @@ Setup Network Folder .. group-tab:: Ubuntu - Check out the video below, and follow along with the steps in this guide to setup a Network Folder on your Linux machine, such that you may create encrypted, private backups of all your Embassy data. + Check out the video below, and follow along with the steps in this guide to setup a Network Folder on your Linux machine, such that you may create encrypted, private backups of all your Start9 server's data. .. youtube:: LLIMC5P3NdY :width: 100% @@ -32,11 +32,11 @@ Setup Network Folder sudo apt install samba && sudo systemctl enable smbd - #. Add your user to samba, replacing ``YOUR_LINUX_USERNAME`` with your Linux username. + #. Add your user to samba, replacing ``$USER`` with your Linux username. .. code-block:: bash - sudo smbpasswd -a YOUR_LINUX_USERNAME + sudo smbpasswd -a $USER First you will be prompted for your linux password, then you will be asked to create a new SMB password for the user with permission to write to your new backup share. Keep it somewhere safe, such as Vaultwarden. @@ -56,19 +56,9 @@ Setup Network Folder .. figure:: /_static/images/cifs/cifs-lin2.png :width: 60% - - You may rename the "Share", if you prefer - **remember this name**, you will need it later in your EmbassyUI + - You may name the share whatever you like, but **remember this name**, as you will need it later in your Start9 server's web UI. Here, we used ``backup-share``. - (Optional) Create a description in the "Comment" section - - #. Check the box for "Allow others to create and delete files in this folder", then click "Create Share" - - .. figure:: /_static/images/cifs/cifs-lin3.png - :width: 60% - - #. Click "Add Permissions Automatically" - - .. figure:: /_static/images/cifs/cifs-lin4.png - :width: 60% #. In case your installation of Ubuntu is running a firewall by default or due to your own custom configuration, enter this command to allow connections to Samba. If it generates an error, you can safely ignore it: @@ -85,16 +75,16 @@ Setup Network Folder sudo apt install samba && sudo systemctl enable smbd - #. Add your user to samba, replacing ``YOUR_LINUX_USERNAME`` with your Linux username. + #. Add your user to samba, replacing ``$USER`` with your Linux username. .. code-block:: bash - sudo usermod -a -G sambashare YOUR_LINUX_USERNAME - sudo smbpasswd -a YOUR_LINUX_USERNAME + sudo usermod -a -G sambashare $USER + sudo smbpasswd -a $USER First you will be prompted for your linux password, then you will be asked to create a new SMB password for the user with permission to write to your new backup share. Keep it somewhere safe, such as Vaultwarden. - #. Right-click the folder that you want to backup to (or create a new one, eg. ``embassy-backup``) and click "Sharing Options" + #. Right-click the folder that you want to backup to (or create a new one, eg. ``start9-backup``) and click "Sharing Options" .. figure:: /_static/images/cifs/cifs-mint0.png :width: 60% @@ -104,7 +94,7 @@ Setup Network Folder .. figure:: /_static/images/cifs/cifs-mint1.png :width: 60% - - You may rename the "Share", if you prefer - **remember this name**, you will need it later in your EmbassyUI. In this example, we call it ``backup-share`` + - You may rename the "Share", if you prefer - **remember this name**, you will need it later in your Start9 server's web UI. In this example, we call it ``backup-share``. - (Optional) Create a description in the "Comment" section @@ -117,21 +107,32 @@ Setup Network Folder .. group-tab:: Other Linux - #. Install Samba if it is not already installed. + 1. Install Samba if it is not already installed. * ``sudo pacman -S samba`` For Arch * ``sudo apt install samba`` For Debian-based distros (Pop-OS, PureOS, etc) * ``sudo yum install samba`` For CentOS/Redhat * ``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, we will call the share ``backup-share`` and its corresponding shared directory will be located at ``/home/user/embassy-backup`` + 2. 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/start9-backup``. Replace ``$USER`` with your Linux username below. - #. Configure Samba by adding the following to the end of the ``/etc/samba/smb.conf`` file: + .. code-block:: bash + + mkdir -p /home/$USER/start9-backup + + .. note:: If you are on Fedora 38+, you need to do an extra step to allow the Samba share in SELinux: + + .. code-block:: bash + + sudo semanage fcontext --add --type "samba_share_t" "/home/$USER/start9-backup(/.*)?" + sudo restorecon -R /home/$USER/start9-backup + + 3. Configure Samba by adding the following to the end of the ``/etc/samba/smb.conf`` file: .. code-block:: [backup-share] - path = "/home/user/embassy-backup" + path = "/home/$USER/start9-backup" create mask = 0600 directory mask = 0700 read only = no @@ -139,28 +140,28 @@ Setup Network Folder Where: - - ``[backup-share]`` is the *Share Name*, or title of the entry, and can be called anything you'd like + - ``[backup-share]`` is the *Share Name* inside brakets, and can be called anything you'd like. We used ``backup-share`` in this example. - ``path`` should be the path to the directory you created earlier Copy the remainder of the entry exactly as it is - #. Open a terminal and enter the following command, replacing ``YOUR-USER`` with your Linux username: + 4. Open a terminal and enter the following command, replacing ``$USER`` with your Linux username: .. code-block:: bash - sudo smbpasswd -a YOUR-USER + sudo smbpasswd -a $USER This creates a password for the Local Network Share. Keep it somewhere safe, such as Vaultwarden. - #. In case your installation of Linux (Pop-OS users take special note!) is running a firewall by default or due to your own custom configuration, enter this command to allow connections to Samba. If it generates an error, you can safely ignore it: + 5. In case your installation of Linux (Pop-OS users take special note!) is running a firewall by default or due to your own custom configuration, enter this command to allow connections to Samba. If it generates an error, you can safely ignore it: .. code-block:: bash sudo ufw allow Samba -Connect Embassy ---------------- +Connect Your Start9 Server +-------------------------- #. Go to *System > Create Backup*. @@ -175,7 +176,7 @@ Connect Embassy #. Fill in the following fields: * 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. In this guide we used ``backup-share`` + * Path - This is the "Share Name" (name of the share in your samba config) and **not** the full directory path. In this guide we use ``backup-share``. * Username - This is your Linux username on the remote machine that you used to create the shared directory * Password - This is the password you set above using ``smbpasswd`` @@ -184,4 +185,4 @@ Connect Embassy #. Click "Save". -That's it! You can now :ref:`Create` encrypted, private backups of all your Embassy data to your Linux machine or external drive!! +That's it! You can now :ref:`Create` encrypted, private backups of all your Start9 server's data to your Linux machine or external drive!!