Differences

This shows you the differences between two versions of the page.

--- omv6:utilities_maint_backup [2022/12/13 03:21] – crashtest
+++ omv6:utilities_maint_backup [2023/07/24 23:12] (current) – [WinSCP] minor typo crashtest
@@ Line 7: / Line 7: @@
 <html><center><span style="color:#000066;font-size:300%;">For Openmediavault 6</span></center></html>
 \\
-<html><center><strong>December 12th, 2022 - First Draft</strong></center></html>
+<html><center><strong>May 31rst, 2023</strong></center></html>
 \\
 \\
 Version History: \\
 December 12th, 2022 - First Draft:\\
+May 31rst, 2023:  Docker instructions were directed to the Compose Plugin doc.  Removed Portainer install. omv6-maint-24.jpg - omv6-maint-25.jpg - omv6-maint-26.jpg purged.
 {{ :divider2.png?600 |}}
@@ Line 56: / Line 57: @@
 WinSCP allows users, beginners and experienced alike, to visualize the Linux file structure in a manner
-similar to Windows Explorer.  WinSCP installs on a Window Client and connects to Linux servers, allowing
+similar to Windows Explorer.  WinSCP installs on a Windows Client and connects to Linux servers, allowing
 users to work with their server remotely. \\
 \\
@@ Line 509: / Line 510: @@
 As users configure their servers, add services, reconfigure shares, move their data around, tweak access controls, etc., servers tend to become “works in progress”. Configuring a server to the user’s preferences can be an evolution that may take weeks or even months. If a complete server rebuild is required, the customization, add-ons, and the collection of various user tweaks may take several hours to recreate. It is this time and effort that Operating System Backup will preserve.\\
 \\
-There are several ways to duplicate an operating system boot drive, but many can be technically involved; requiring network access to remote servers, bootable utilities and somewhat complex processes.\\
+There are several ways to duplicate an operating system boot drive but many can be technically involved, requiring network access to remote servers, bootable utilities and somewhat complex processes.\\
 \\
@@ Line 526: / Line 527: @@
 **The practical issues of maintaining boot drive clones – when to update and rotate?**\\
 \\
-. Linux Operating System package and security updates are unlikely to have a direct on the operation of the server.  While updating the boot drive is not strictly required after a package or security update, it would make sense to wait a week or two (more?) to insure that all is working.  Remember, the cloned drive is "the fall back".  Insure that there are no ill effects with OS update, before updating the clone. \\
+. Linux Operating System package and security updates are unlikely to have a direct impact on the operation of the server.  While updating the boot drive is not strictly required after a package or security update, it would make sense to wait a week or two (more?) to insure that all is working.  Remember, the cloned drive is "the fall back".  Insure that there are no ill effects with an OS update, before updating the clone. \\
 \\
-. Add-on packages that are direct installed on the boot drive, Dockers (Plex, Urbackup, Pi-Hole, etc.), are another matter.  If add-ons are updated, where the update may change the way server add-on's interact with the data they generate, updating the boot drive may be a good idea.\\
+. Add-on packages that are direct installed on the boot drive, Dockers (Plex, Urbackup, Pi-Hole, etc.), are another matter.  If add-ons are updated, where the update may change the way server add-on's interact with the data they generate, updating the cloned boot drive may be a good idea.\\
 \\
-. If a network share is added, deleted, or any aspect of the NAS is reconfigured that changes the operation of the NAS; the backup would need to be updated. Otherwise,  if needed for recovery, the configuration of the cloned boot drive would not mesh with the configuration and contents of data storage drives.\\
+. If a network share is added, deleted, or any aspect of the NAS is reconfigured that changes the operation of the NAS, the backup would need to be updated. Otherwise,  if needed for recovery, the configuration of the cloned boot drive would not mesh with the configuration and contents of data storage drives.\\
 \\
 . If a cloning mistake is made (let’s respect Murphy’s Law), a 3rd clone could become a “fallback of last resort”. Given that Linux package upgrades and openmediavault sub-version upgrades have little to no effect on network shares or the high level configuration of the NAS, a 3rd clone can be maintained that is updated //only// when the NAS configuration is changed.\\
@@ Line 560: / Line 561: @@
 **At this point users might consider marking the working SD-card or thumb-drive to insure that it doesn’t get mixed up with the blank card. Otherwise, it is possible to read a “blank card” and use the blank image to “overwrite” the working card.**\\
 \\
-Insert the **working** card and start USBimager\\
+Insert the **working** card and start USBimager.\\
 \\
 <html>
@@ Line 654: / Line 655: @@
 ==== Dockers - General ====
-While Dockers are an avenue toward adding //extensive// functionality to openmediavault, they are an advanced topic that may prove to be frustrating for beginners. To get started, beginners should consider installing Docker, then Portainer, as found under System, OMV-Extras. While it’s command line oriented, this [[https://docker-curriculum.com/|Docker Tutorial]] is very helpful for understanding basic concepts. User authored Docker - How To’s can be found on the openmediavault forum in the [[https://forum.openmediavault.org/index.php?board/29-guides/|Guides section]]. In addition, there’s a forum section dedicated to [[https://forum.openmediavault.org/index.php?board/39-docker/|Docker issues and questions]].
+While Dockers are an avenue toward adding //extensive// functionality to openmediavault, they are an advanced topic that may prove to be frustrating for beginners. To get started, after installing OMV-Extras, beginners should consider installing the Compose Plugin and reviewing the [[https://wiki.omv-extras.org/doku.php?id=omv6:docker_in_omv|Compose Plugin document]].\\
+\\
+While it’s command line oriented, this [[https://docker-curriculum.com/|Docker Tutorial]] is very helpful for understanding basic concepts. User authored Docker - How To’s can be found on the openmediavault forum in the [[https://forum.openmediavault.org/index.php?board/29-guides/|Guides section]]. In addition, there’s a forum section dedicated to [[https://forum.openmediavault.org/index.php?board/39-docker/|Docker issues and questions]].
 === So, What is a “Docker”? ===
@@ Line 666: / Line 669: @@
 === Installing Docker ===
-Installing [[https://wiki.omv-extras.org/doku.php?id=omv6:new_user_guide#omv-extras|OMV-Extras]] is a prerequisite to installing Docker.\\
+Effective May 30th, 2023 Docker is supported with the -> [[https://wiki.omv-extras.org/doku.php?id=omv6:omv6_plugins:docker_compose|Docker Compose Plugin]]
-\\
-Under **System**, **OMV-Extras**, select **Docker**.
-**Before installing Docker:**
+A guide for installing Dockers is covered in -> [[https://wiki.omv-extras.org/doku.php?id=omv6:docker_in_omv|Docker in OMV]].
-Take note of the default Docker Storage location. **/var/lib/docker** is located on the **boot drive**. This location is not an issue for hard drives and SSD’s of medium capacity (notionally, 128GB or larger). However, when using flash media to boot (8GB to 32GB), the boot drive is not a good location for media servers or downloader type Dockers. There are two possible solutions:
-  * The easiest solution is to change the Docker Storage path to a data drive. If the default path is changed, Downloader output and metadata created by media servers (Plex, Emby and others) will be stored on a data drive by default.
-  * A more advanced solution would be to leave the default storage location in place (var/lib/docker) and configure Downloaders and media servers to store their output and metadata on a data drive, but this requires individual configuration of each Docker.
-\\
-<html><center><strong>Proceed with the Docker Install</strong></center></html>
-{{ :docs_in_draft:omv6-maint-24.jpg?600 |}}
-An install dialog box will popup and scroll as files are downloaded and installed. At the end, "End of Line" will be displayed. Click the **Close** button.\\
-\\
-<html><center>The <b>Status</b> line will report: <b>Installed and running</b>.</center></html>
-\\
-----
-\\
-**General Note:**\\
-Docker is now installed and it can be controlled from the command line.  However, for most users, controlling Docker from the command line may be an daunting task.
-[[https://docs.portainer.io/user/home|Portainer]] and [[https://yacht.sh/|Yacht]] are Docker control utilities that provide a GUI for storing Docker images and configuring the various parameters associated with a Docker Container.\\
-\\
-Portainer and Yacht have their individual strengths and weaknesses.  Users are encouraged to investigate both but, for the purposes of this document, a walk through for installing Portainer is provided.\\
-\\
 ----
-=== Installing Portainer ===
-\\
-Under **System**, **OMV-Extras**, **Portainer**:
-<html><center>Click the <b>install</b> button.</center></html>
-{{ :docs_in_draft:omv6-maint-25.jpg?600 |}}
-An install dialog box will popup and scroll as the Portainer image is downloaded and a container is initialized. At the end, "**End of Line**" will be displayed.\\
-\\
-Click the **Close** button.\\
-\\
-With a successful install the **Status** line will report; **Up X seconds** (or minutes, etc.)\\
-\\
-----
-\\
-Click on **Open Web**.\\
-\\
-<html>
-<body>
-  <table width="100%" border="0">
-    <tr>
-      <td colspan="2" style="background-color:#69A5FF;height:30px;">
-        <strong><span style="color:#FFFFFF;font-size:110%;">&#160; Note</span></strong>
-      </td>
-    </tr>
-    <tr>
-      <td style="background-color:#E6FEFF;height:25px;width:380px;">
-        Some browsers may block "popups".  If the portainer web page doesn't open in a new browser tab, configure your web browser to allow your server to create new popup windows.
-    </tr>
-  </table>
-</body>
-</html>
-\\
-At this point, Portainer is completely unconfigured. The first configuration requirement is setting a **password** for the **admin** user. Take note of the username **admin** and the entered **password**. They will be needed to log into Portainer again.\\
-\\
-----
-\\
-When a password is entered and confirmed, the Portainer page will change to **Quick Setup**.\\
-\\
-<html><center>From the left hand menu, click on the "<b>Home</b>" bar.  Then, on the right under <b>Environments</b>, click on "<b>Local</b>".</center></html>
-\\
-{{ ::omv6-maint-26.jpg?600 |}}
-Portainer is now running with a minimal configuration.\\
-\\
-At this point, on the left hand menu, menu selections for the **Local Environment** can be found.  The Dashboard will supply Portainer's status.  One image and one container will be running.  This image and container belong to the Portainer instance itself.  \\
-\\
-For more information on configuring Dockers in Portainer, portainer.io hosts → [[https://www.portainer.io/portainer-tutorials| "101" tutorials]].  In addition, there are other Portainer "How-To" resources available on the web.\\
-\\
 ----
 \\
@@ Line 758: / Line 688: @@
 **First:**\\
 \\
-When installing a Docker, for the greatest chance of success, it is suggested that users follow the guidance provided in [[https://forum.openmediavault.org/index.php?board/29-guides/|Guides Section]] of the openmediavault forum.\\
+Potential Docker users must use Dockers that support their architecture. The three primary architectures supported by openmediavault are **ARMHF** or **ARM64**, **i386(32 bit)**, and **amd64(64 bit)**. In most cases, 32bit Dockers will run on 64bit hardware. While there may be exceptions, i386 and amd64 Docker images may not run on ARM platforms. “**Multi-arch**” (multiple architecture) Docker images are more platform flexible.\\
 \\
 **Second:**\\
 \\
-Potential Docker users must use Dockers that support their architecture. The three primary architectures supported by openmediavault are **ARMHF** or **ARM64**, **i386(32 bit)**, and **amd64(64 bit)**. In most cases, 32bit Dockers will run on 64bit hardware. While there may be exceptions, i386 and amd64 Docker images may not run on ARM platforms. “**Multi-arch**” (multiple architecture) Docker images are more platform flexible.\\
+To increase the chance of success, when attempting to install a Docker without a guide, look for the more popular Dockers with the highest number of “pulls” on the Docker Hub.  There are good reasons why these Dockers are broadly popular – they tend to work. -> [[https://hub.docker.com/|hub.docker.com]]\\
+(Note: It is not necessary to sign in or to create an account.  Simply use the search bar.)\\
 \\
 **Third:**\\
-\\
-To increase the chance of success, when attempting to install a Docker without a guide, look for the more popular Dockers with the highest number of “pulls” on the Docker Hub. [[https://hub.docker.com/search/type=image&image_filter=official?q=|(hub.docker.com)]] There are good reasons why these Dockers are broadly popular – they tend to work.\\
-\\
-**Forth:**\\
 \\
 In the vast majority of cases, Dockers that fail to work won’t have anything to do with openmediavault or Portainer. Their issues tend to originate from selecting the wrong architecture, selecting the wrong network mode (host, bridged, macvlan) for the application, other configuration issues (such as port 80 OMV/Docker conflicts), permissions problems or the Dockers themselves.\\
@@ Line 887: / Line 814: @@
 \\
 If you found this guide to be helpful, please consider a modest donation to support the
-hosting costs of this server (OMV-Extras) and the project (Openmediavault). \\
+hosting costs of this server (OMV-Extras) and the host project (Openmediavault). \\
 \\
 **OMV-Extras.org**