| Both sides previous revision Previous revision Next revision | Previous revision |
| omv6:utilities_maint_backup [2023/02/07 00:07] – [A Closing Note] crashtest | omv6:utilities_maint_backup [2023/07/24 23:12] (current) – [WinSCP] minor typo crashtest |
|---|
| <html><center><span style="color:#000066;font-size:300%;">For Openmediavault 6</span></center></html> | <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: \\ | Version History: \\ |
| December 12th, 2022 - First Draft:\\ | 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 |}} | {{ :divider2.png?600 |}} |
| |
| WinSCP allows users, beginners and experienced alike, to visualize the Linux file structure in a manner | 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. \\ | users to work with their server remotely. \\ |
| \\ | \\ |
| ==== Dockers - General ==== | ==== 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”? === | === So, What is a “Docker”? === |
| === Installing Docker === | === 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%;">  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.\\ | |
| \\ | |
| ---- | ---- |
| \\ | \\ |
| **First:**\\ | **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:**\\ | **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:**\\ | **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.\\ | 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.\\ |