omv7:omv7_plugins:docker_compose

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
omv7:omv7_plugins:docker_compose [2024/04/27 17:45] – chenteomv7:omv7_plugins:docker_compose [2025/03/30 14:28] (current) – [Schedule (Updates and Backups)] chente
Line 13: Line 13:
  
 ===== Summary ===== ===== Summary =====
-[[https://docs.docker.com/compose/|{{ :omv6:omv6_plugins:compose6.png?direct&200|docker compose}}]]+[[https://docs.docker.com/compose/|{{ ::omv7:omv7_plugins:compose7-1.png?direct&200|Go to -> Docker compose}}]]
   * Docker is a technology that enables the creation and use of Linux containers. A container is a closed environment where one or more applications and their dependencies are installed, grouped and isolated from each other, running on the same operating system kernel.   * Docker is a technology that enables the creation and use of Linux containers. A container is a closed environment where one or more applications and their dependencies are installed, grouped and isolated from each other, running on the same operating system kernel.
   * Docker allows you to install, uninstall, modify, update applications as many times as you want without causing damage to the system.   * Docker allows you to install, uninstall, modify, update applications as many times as you want without causing damage to the system.
Line 24: Line 24:
 ---- ----
  
-[[omv7:docker_in_omv|{{ :omv7:dockeromv7-1.png?direct&200|Docker in OMV}}]]+
 ===== Docker in OMV - Initial Setup ===== ===== Docker in OMV - Initial Setup =====
 +[[omv7:docker_in_omv|{{ :omv7:dockeromv7-1.png?direct&200|Go to -> Docker in OMV 7}}]]
 +\\
 +[[omv7:docker_in_omv|Docker in OMV 7]] is a document that establishes a method to successfully install any application on OMV using Docker.
  
-  * [[omv7:docker_in_omv|Docker in OMV]] is a document that provides a simple and secure docker management method. This document establishes a method to successfully install a docker application on OMV. It is recommended to read it before installing docker or openmediavault-compose.+**It is recommended to read it before installing Docker or openmediavault-compose.** Go to -> [[omv7:docker_in_omv|Docker in OMV 7]]
  
 ---- ----
Line 35: Line 38:
   * [[https://wiki.omv-extras.org/doku.php?id=misc_docs:omv_extras|OMV-Extras]] must be pre-installed.   * [[https://wiki.omv-extras.org/doku.php?id=misc_docs:omv_extras|OMV-Extras]] must be pre-installed.
   * A **64-bit system** is desirable to run docker. If your system only supports 32-bit you will be able to run some containers, many others will be inaccessible to you. In addition, there are many other incompatibilities for 32-bit systems.   * A **64-bit system** is desirable to run docker. If your system only supports 32-bit you will be able to run some containers, many others will be inaccessible to you. In addition, there are many other incompatibilities for 32-bit systems.
- 
- 
- 
- 
  
 ---- ----
Line 44: Line 43:
 ===== Installation ===== ===== Installation =====
  
 +{{ :omv7:dockeromv7-7.jpg?direct&1200 |Docker Repo}}
 In OMV7's GUI:\\ In OMV7's GUI:\\
-Under **System** > **omv-extras** Click on the **Docker repo** button and click on the **Save** button. Now the docker repository is activated and you can install the compose plugin. +Under SYSTEM > OMV-EXTRAS Click on the DOCKER REPO button and click on the SAVE button. Now the docker repository is activated and you can install the compose plugin and docker.\\ 
-Under **System** > **Plugins** find and highlight **openmediavault-compose 7.X**, and click the **Install** button.+Under SYSTEM > PLUGINS find and highlight **openmediavault-compose 7.X**, and click the INSTALL button.
   * Installing the openmediavault-compose plugin will also install the openmediavault-sharerootfs plugin as a dependency.   * Installing the openmediavault-compose plugin will also install the openmediavault-sharerootfs plugin as a dependency.
 \\ \\
Line 54: Line 54:
 Do not uninstall the openmediavault-sharerootfs plugin. It is a dependency of the openmediavault-compose plugin. Uninstalling openmediavault-sharerootfs when the openmediavault-compose plugin is installed will cause the openmediavault-compose plugin to be uninstalled. Do not uninstall the openmediavault-sharerootfs plugin. It is a dependency of the openmediavault-compose plugin. Uninstalling openmediavault-sharerootfs when the openmediavault-compose plugin is installed will cause the openmediavault-compose plugin to be uninstalled.
 </tr></table></body></html> </tr></table></body></html>
- 
 ---- ----
  
Line 86: Line 85:
   * In this field we can define a folder already created where we have the user data.   * In this field we can define a folder already created where we have the user data.
   * The plugin will use this path if we use the CHANGE_TO_COMPOSE_DATA_PATH string in any compose file. This behavior is similar to that of a global environment variable.   * The plugin will use this path if we use the CHANGE_TO_COMPOSE_DATA_PATH string in any compose file. This behavior is similar to that of a global environment variable.
 +  * If you are not going to use the CHANGE_TO_COMPOSE_DATA_PATH variable you can leave this field unconfigured.
   * To define this folder do the following:   * To define this folder do the following:
     * In the **Shared Folder** field select a shared folder.     * In the **Shared Folder** field select a shared folder.
Line 639: Line 639:
     * If you want to have several versioned backups over time, you must make a copy later with another specialized application for this purpose.     * If you want to have several versioned backups over time, you must make a copy later with another specialized application for this purpose.
   * The containers that were running when the process started are started again. Those who were detained will continue to be detained.   * The containers that were running when the process started are started again. Those who were detained will continue to be detained.
 +  * A copy of the global environment variables file will be added to the backup. This file will be located in the folder defined for the backup and is named ''global.env''
 The update task performs the following process: The update task performs the following process:
   * Download the container images included in the compose file.   * Download the container images included in the compose file.
   * Recreate the containers with the new image if they were running.   * Recreate the containers with the new image if they were running.
-\\+
 <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 <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;"> </span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">
-At this time, the plug-in backup utility does not resolve variables in volume paths. Define paths using global environment variables only for paths that you do not need to include in a backup.<br> +The advantage of the plugin's backup utility is that it stops the containers before doing the backup, which is actually a simple rsync. After that is when you should use whatever specialized backup utility you want, with deduplication, versioning, etc., to backup that folder copied with rsync. If you use any backup application directly with the containers running you can get an inconsistent backup.
-Alternatively you can use symlinks in the compose file.+
 </tr></table></body></html> </tr></table></body></html>
  
Line 653: Line 653:
 === Create === === Create ===
  
-{{ :omv6:omv6_plugins:compose9.jpg?direct&400|Schedule}} +{{ :omv7:omv7_plugins:compose9.jpg?direct&400|Schedule}} 
-Opens a dialog for scheduling backup jobs.+Opens a dialog box to schedule container backup and/or update jobs.
  
   * **Settings**   * **Settings**
Line 725: Line 725:
 === How to update a single docker-compose container === === How to update a single docker-compose container ===
 \\ \\
-  * Go to **Services** > **Compose** > **Containers** and select the container you want to update.+  * Go to **Services** > **Compose** > **Services** and select the container you want to update.
   * Press the **Pull** button. This will download the latest available image from that container.   * Press the **Pull** button. This will download the latest available image from that container.
   * Now go to **Services** > **Compose** > **Files** and select the file where that container is defined.   * Now go to **Services** > **Compose** > **Files** and select the file where that container is defined.
  • omv7/omv7_plugins/docker_compose.1714239948.txt.gz
  • Last modified: 2024/04/27 17:45
  • by chente